update docs

elastic · Nov 4, 2020 · ec31106 · ec31106
1 parent 2de1df2
commit ec31106
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 6 deletions.
diff --git a/...pressions/public/kibana-plugin-plugins-expressions-public.expressionsservice.md b/...pressions/public/kibana-plugin-plugins-expressions-public.expressionsservice.md
@@ -39,8 +39,8 @@ export declare class ExpressionsService implements PersistableState<ExpressionAs
 |  [getType](./kibana-plugin-plugins-expressions-public.expressionsservice.gettype.md) |  | <code>ExpressionsServiceStart['getType']</code> |  |
 |  [getTypes](./kibana-plugin-plugins-expressions-public.expressionsservice.gettypes.md) |  | <code>() =&gt; ReturnType&lt;Executor['getTypes']&gt;</code> | Returns POJO map of all registered expression types, where keys are names of the types and values are <code>ExpressionType</code> instances. |
 |  [inject](./kibana-plugin-plugins-expressions-public.expressionsservice.inject.md) |  | <code>(state: ExpressionAstExpression, references: SavedObjectReference[]) =&gt; ExpressionAstExpression</code> | Injects saved object references into expression AST |
-|  [migrate](./kibana-plugin-plugins-expressions-public.expressionsservice.migrate.md) |  | <code>(state: SerializableState, version: string) =&gt; ExpressionAstExpression</code> | Injects saved object references into expression AST |
-|  [migrateToLatest](./kibana-plugin-plugins-expressions-public.expressionsservice.migratetolatest.md) |  | <code>(state: unknown, version: string) =&gt; ExpressionAstExpression</code> | Injects saved object references into expression AST |
+|  [migrate](./kibana-plugin-plugins-expressions-public.expressionsservice.migrate.md) |  | <code>(state: SerializableState, version: string) =&gt; ExpressionAstExpression</code> | Runs the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1) |
+|  [migrateToLatest](./kibana-plugin-plugins-expressions-public.expressionsservice.migratetolatest.md) |  | <code>(state: unknown, version: string) =&gt; ExpressionAstExpression</code> | Migrates expression to the latest version |
 |  [registerFunction](./kibana-plugin-plugins-expressions-public.expressionsservice.registerfunction.md) |  | <code>(functionDefinition: AnyExpressionFunctionDefinition &#124; (() =&gt; AnyExpressionFunctionDefinition)) =&gt; void</code> | Register an expression function, which will be possible to execute as part of the expression pipeline.<!-- -->Below we register a function which simply sleeps for given number of milliseconds to delay the execution and outputs its input as-is.
 ```ts
 expressions.registerFunction({

diff --git a/...s/public/kibana-plugin-plugins-expressions-public.expressionsservice.migrate.md b/...s/public/kibana-plugin-plugins-expressions-public.expressionsservice.migrate.md
@@ -4,7 +4,7 @@
 
 ## ExpressionsService.migrate property
 
-Injects saved object references into expression AST
+Runs the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)
 
 <b>Signature:</b>
 

diff --git a/.../kibana-plugin-plugins-expressions-public.expressionsservice.migratetolatest.md b/.../kibana-plugin-plugins-expressions-public.expressionsservice.migratetolatest.md
@@ -4,7 +4,7 @@
 
 ## ExpressionsService.migrateToLatest property
 
-Injects saved object references into expression AST
+Migrates expression to the latest version
 
 <b>Signature:</b>
 

diff --git a/...ions/public/kibana-plugin-plugins-expressions-public.reactexpressionrenderer.md b/...ions/public/kibana-plugin-plugins-expressions-public.reactexpressionrenderer.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-ReactExpressionRenderer: ({ className, dataAttrs, padding, renderError, expression, onEvent, reload$, debounce, ...expressionLoaderOptions }: ReactExpressionRendererProps) => JSX.Element
+ReactExpressionRenderer: ({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ReactExpressionRendererProps) => JSX.Element
 ```
diff --git a/...public/kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.md b/...public/kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.md
@@ -18,6 +18,7 @@ export interface ReactExpressionRendererProps extends IExpressionLoaderParams
 |  [dataAttrs](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.dataattrs.md) | <code>string[]</code> |  |
 |  [debounce](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.debounce.md) | <code>number</code> |  |
 |  [expression](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.expression.md) | <code>string &#124; ExpressionAstExpression</code> |  |
+|  [onData$](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.ondata_.md) | <code>&lt;TData, TInspectorAdapters&gt;(data: TData, adapters?: TInspectorAdapters) =&gt; void</code> |  |
 |  [onEvent](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.onevent.md) | <code>(event: ExpressionRendererEvent) =&gt; void</code> |  |
 |  [padding](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.padding.md) | <code>'xs' &#124; 's' &#124; 'm' &#124; 'l' &#124; 'xl'</code> |  |
 |  [reload$](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.reload_.md) | <code>Observable&lt;unknown&gt;</code> | An observable which can be used to re-run the expression without destroying the component |

diff --git a/...ibana-plugin-plugins-expressions-public.reactexpressionrendererprops.ondata_.md b/...ibana-plugin-plugins-expressions-public.reactexpressionrendererprops.ondata_.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [ReactExpressionRendererProps](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.md) &gt; [onData$](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.ondata_.md)
+
+## ReactExpressionRendererProps.onData$ property
+
+<b>Signature:</b>
+
+```typescript
+onData$?: <TData, TInspectorAdapters>(data: TData, adapters?: TInspectorAdapters) => void;
+```
diff --git a/src/plugins/expressions/public/public.api.md b/src/plugins/expressions/public/public.api.md
@@ -1059,7 +1059,7 @@ export interface Range {
 // Warning: (ae-missing-release-tag) "ReactExpressionRenderer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const ReactExpressionRenderer: ({ className, dataAttrs, padding, renderError, expression, onEvent, reload$, debounce, ...expressionLoaderOptions }: ReactExpressionRendererProps) => JSX.Element;
+export const ReactExpressionRenderer: ({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ReactExpressionRendererProps) => JSX.Element;
 
 // Warning: (ae-missing-release-tag) "ReactExpressionRendererProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -1074,6 +1074,8 @@ export interface ReactExpressionRendererProps extends IExpressionLoaderParams {
     // (undocumented)
     expression: string | ExpressionAstExpression;
     // (undocumented)
+    onData$?: <TData, TInspectorAdapters>(data: TData, adapters?: TInspectorAdapters) => void;
+    // (undocumented)
     onEvent?: (event: ExpressionRendererEvent) => void;
     // (undocumented)
     padding?: 'xs' | 's' | 'm' | 'l' | 'xl';