kibana/api_docs/expression_error.json
Stacey Gammon 283223101d
Improve deprecated API list, and update api docs (#106942)
* Code to adjust deprecated api list

* updated docs

* fix and update tests
2021-07-28 12:44:17 -04:00

258 lines
6.8 KiB
JSON

{
"id": "expressionError",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionError",
"id": "def-public.debugRenderer",
"type": "Function",
"tags": [],
"label": "debugRenderer",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<any>"
],
"source": {
"path": "src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx",
"lineNumber": 33
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionError",
"id": "def-public.errorRenderer",
"type": "Function",
"tags": [],
"label": "errorRenderer",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
"ErrorRendererConfig",
">"
],
"source": {
"path": "src/plugins/expression_error/public/expression_renderers/error_renderer.tsx",
"lineNumber": 30
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionError",
"id": "def-public.LazyDebugComponent",
"type": "Function",
"tags": [],
"label": "LazyDebugComponent",
"description": [],
"signature": [
"React.ExoticComponent<{ payload: unknown; }> & { readonly _result: ({ payload }: { payload: unknown; }) => JSX.Element; }"
],
"source": {
"path": "src/plugins/expression_error/public/components/index.ts",
"lineNumber": 11
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "expressionError",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"source": {
"path": "node_modules/@types/react/index.d.ts",
"lineNumber": 359
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionError",
"id": "def-public.LazyErrorComponent",
"type": "Function",
"tags": [],
"label": "LazyErrorComponent",
"description": [],
"signature": [
"React.ExoticComponent<React.PropsWithChildren<",
"Props",
">> & { readonly _result: React.FC<",
"Props",
">; }"
],
"source": {
"path": "src/plugins/expression_error/public/components/index.ts",
"lineNumber": 10
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "expressionError",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"source": {
"path": "node_modules/@types/react/index.d.ts",
"lineNumber": 359
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "expressionError",
"id": "def-public.renderers",
"type": "Array",
"tags": [],
"label": "renderers",
"description": [],
"signature": [
"(() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
"ErrorRendererConfig",
">)[]"
],
"source": {
"path": "src/plugins/expression_error/public/expression_renderers/index.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "expressionError",
"id": "def-public.ExpressionErrorPluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionErrorPluginStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "src/plugins/expression_error/public/plugin.ts",
"lineNumber": 22
},
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "expressionError",
"id": "def-common.JSON",
"type": "string",
"tags": [],
"label": "JSON",
"description": [],
"signature": [
"\"JSON\""
],
"source": {
"path": "src/plugins/expression_error/common/constants.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionError",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionError\""
],
"source": {
"path": "src/plugins/expression_error/common/constants.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionError",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionError\""
],
"source": {
"path": "src/plugins/expression_error/common/constants.ts",
"lineNumber": 9
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}