mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
32ebd0af7b
* Use Serializable from package * Rename to align with core * fix * more replacements * docssss * fix * Move it to @kbn/utility-types and remove core export * buildy build * tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Liza Katz <lizka.k@gmail.com>
36 lines
3.3 KiB
Markdown
36 lines
3.3 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [kibana-plugin-plugins-expressions-server](./kibana-plugin-plugins-expressions-server.md) > [ExpressionFunction](./kibana-plugin-plugins-expressions-server.expressionfunction.md)
|
|
|
|
## ExpressionFunction class
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export declare class ExpressionFunction implements PersistableState<ExpressionAstFunction['arguments']>
|
|
```
|
|
|
|
## Constructors
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [(constructor)(functionDefinition)](./kibana-plugin-plugins-expressions-server.expressionfunction._constructor_.md) | | Constructs a new instance of the <code>ExpressionFunction</code> class |
|
|
|
|
## Properties
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [accepts](./kibana-plugin-plugins-expressions-server.expressionfunction.accepts.md) | | <code>(type: string) => boolean</code> | |
|
|
| [aliases](./kibana-plugin-plugins-expressions-server.expressionfunction.aliases.md) | | <code>string[]</code> | Aliases that can be used instead of <code>name</code>. |
|
|
| [args](./kibana-plugin-plugins-expressions-server.expressionfunction.args.md) | | <code>Record<string, ExpressionFunctionParameter></code> | Specification of expression function parameters. |
|
|
| [disabled](./kibana-plugin-plugins-expressions-server.expressionfunction.disabled.md) | | <code>boolean</code> | |
|
|
| [extract](./kibana-plugin-plugins-expressions-server.expressionfunction.extract.md) | | <code>(state: ExpressionAstFunction['arguments']) => {</code><br/><code> state: ExpressionAstFunction['arguments'];</code><br/><code> references: SavedObjectReference[];</code><br/><code> }</code> | |
|
|
| [fn](./kibana-plugin-plugins-expressions-server.expressionfunction.fn.md) | | <code>(input: ExpressionValue, params: Record<string, any>, handlers: object) => ExpressionValue</code> | Function to run function (context, args) |
|
|
| [help](./kibana-plugin-plugins-expressions-server.expressionfunction.help.md) | | <code>string</code> | A short help text. |
|
|
| [inject](./kibana-plugin-plugins-expressions-server.expressionfunction.inject.md) | | <code>(state: ExpressionAstFunction['arguments'], references: SavedObjectReference[]) => ExpressionAstFunction['arguments']</code> | |
|
|
| [inputTypes](./kibana-plugin-plugins-expressions-server.expressionfunction.inputtypes.md) | | <code>string[] | undefined</code> | Type of inputs that this function supports. |
|
|
| [migrations](./kibana-plugin-plugins-expressions-server.expressionfunction.migrations.md) | | <code>{</code><br/><code> [key: string]: (state: SerializableRecord) => SerializableRecord;</code><br/><code> }</code> | |
|
|
| [name](./kibana-plugin-plugins-expressions-server.expressionfunction.name.md) | | <code>string</code> | Name of function |
|
|
| [telemetry](./kibana-plugin-plugins-expressions-server.expressionfunction.telemetry.md) | | <code>(state: ExpressionAstFunction['arguments'], telemetryData: Record<string, any>) => Record<string, any></code> | |
|
|
| [type](./kibana-plugin-plugins-expressions-server.expressionfunction.type.md) | | <code>string</code> | Return type of function. This SHOULD be supplied. We use it for UI and autocomplete hinting. We may also use it for optimizations in the future. |
|
|
|