📝 Update API doc

elastic · Nov 23, 2020 · 084a22f · 084a22f
1 parent 1fbdeef
commit 084a22f
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/...lopment/plugins/data/public/kibana-plugin-plugins-data-public.datatabletocsv.md b/...lopment/plugins/data/public/kibana-plugin-plugins-data-public.datatabletocsv.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [datatableToCSV](./kibana-plugin-plugins-data-public.datatabletocsv.md)
+
+## datatableToCSV() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function datatableToCSV({ columns, rows }: Datatable, { csvSeparator, quoteValues, formatFactory, raw }: Omit<CSVOptions, 'asString'>): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  { columns, rows } | <code>Datatable</code> |  |
+|  { csvSeparator, quoteValues, formatFactory, raw } | <code>Omit&lt;CSVOptions, 'asString'&gt;</code> |  |
+
+<b>Returns:</b>
+
+`string`
+
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
@@ -41,6 +41,7 @@
 
 |  Function | Description |
 |  --- | --- |
+|  [datatableToCSV({ columns, rows }, { csvSeparator, quoteValues, formatFactory, raw })](./kibana-plugin-plugins-data-public.datatabletocsv.md) |  |
 |  [exportAsCSVs(filename, datatables, options)](./kibana-plugin-plugins-data-public.exportascsvs.md) |  |
 |  [getDefaultQuery(language)](./kibana-plugin-plugins-data-public.getdefaultquery.md) |  |
 |  [getEsPreference(uiSettings, sessionId)](./kibana-plugin-plugins-data-public.getespreference.md) |  |

diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
@@ -469,6 +469,12 @@ export interface DataPublicPluginStartUi {
     SearchBar: React.ComponentType<StatefulSearchBarProps>;
 }
 
+// Warning: (ae-forgotten-export) The symbol "CSVOptions" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "datatableToCSV" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function datatableToCSV({ columns, rows }: Datatable_3, { csvSeparator, quoteValues, formatFactory, raw }: Omit<CSVOptions, 'asString'>): string;
+
 // Warning: (ae-missing-release-tag) "DuplicateIndexPatternError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -679,7 +685,6 @@ export type ExistsFilter = Filter & {
     exists?: FilterExistsProperty;
 };
 
-// Warning: (ae-forgotten-export) The symbol "CSVOptions" needs to be exported by the entry point index.d.ts
 // Warning: (ae-missing-release-tag) "exportAsCSVs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)