mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
32 lines
2.6 KiB
Markdown
32 lines
2.6 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) > [ExecutionContract](./kibana-plugin-plugins-expressions-public.executioncontract.md)
|
|
|
|
## ExecutionContract class
|
|
|
|
`ExecutionContract` is a wrapper around `Execution` class. It provides the same functionality but does not expose Expressions plugin internals.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export declare class ExecutionContract<Input = unknown, Output = unknown, InspectorAdapters = unknown>
|
|
```
|
|
|
|
## Constructors
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [(constructor)(execution)](./kibana-plugin-plugins-expressions-public.executioncontract._constructor_.md) | | Constructs a new instance of the <code>ExecutionContract</code> class |
|
|
|
|
## Properties
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [cancel](./kibana-plugin-plugins-expressions-public.executioncontract.cancel.md) | | <code>() => void</code> | Cancel the execution of the expression. This will set abort signal (available in execution context) to aborted state, letting expression functions to stop their execution. |
|
|
| [execution](./kibana-plugin-plugins-expressions-public.executioncontract.execution.md) | | <code>Execution<Input, Output, InspectorAdapters></code> | |
|
|
| [getAst](./kibana-plugin-plugins-expressions-public.executioncontract.getast.md) | | <code>() => ExpressionAstExpression</code> | Get AST used to execute the expression. |
|
|
| [getData](./kibana-plugin-plugins-expressions-public.executioncontract.getdata.md) | | <code>() => Promise<Output | ExpressionValueError></code> | Returns the final output of expression, if any error happens still wraps that error into <code>ExpressionValueError</code> type and returns that. This function never throws. |
|
|
| [getExpression](./kibana-plugin-plugins-expressions-public.executioncontract.getexpression.md) | | <code>() => string</code> | Get string representation of the expression. Returns the original string if execution was started from a string. If execution was started from an AST this method returns a string generated from AST. |
|
|
| [inspect](./kibana-plugin-plugins-expressions-public.executioncontract.inspect.md) | | <code>() => InspectorAdapters</code> | Get Inspector adapters provided to all functions of expression through execution context. |
|
|
| [isPending](./kibana-plugin-plugins-expressions-public.executioncontract.ispending.md) | | <code>boolean</code> | |
|
|
|