kibana/api_docs/kbn_esql_validation_autocomplete.devdocs.json

4236 lines
No EOL
149 KiB
JSON

{
"id": "@kbn/esql-validation-autocomplete",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition",
"type": "Function",
"tags": [],
"label": "checkFunctionArgMatchesDefinition",
"description": [
"\nChecks if an AST function argument is of the correct type\ngiven the definition."
],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
", parameterDefinition: { name: string; type: ",
"FunctionParameterType",
"; optional?: boolean | undefined; noNestingFunctions?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; literalOptions?: string[] | undefined; literalSuggestions?: string[] | undefined; }, references: ",
"ReferenceMaps",
", parentCommand: string | undefined) => boolean | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$2",
"type": "Object",
"tags": [],
"label": "parameterDefinition",
"description": [],
"signature": [
"{ name: string; type: ",
"FunctionParameterType",
"; optional?: boolean | undefined; noNestingFunctions?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; literalOptions?: string[] | undefined; literalSuggestions?: string[] | undefined; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$3",
"type": "Object",
"tags": [],
"label": "references",
"description": [],
"signature": [
"ReferenceMaps"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$4",
"type": "string",
"tags": [],
"label": "parentCommand",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectVariables",
"type": "Function",
"tags": [],
"label": "collectVariables",
"description": [],
"signature": [
"(commands: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>[], fields: Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLRealField",
"text": "ESQLRealField"
},
">, queryString: string) => Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLVariable",
"text": "ESQLVariable"
},
"[]>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/variables.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectVariables.$1",
"type": "Array",
"tags": [],
"label": "commands",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/variables.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectVariables.$2",
"type": "Object",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLRealField",
"text": "ESQLRealField"
},
">"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/variables.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectVariables.$3",
"type": "string",
"tags": [],
"label": "queryString",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/variables.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getActions",
"type": "Function",
"tags": [],
"label": "getActions",
"description": [],
"signature": [
"(innerText: string, markers: (",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
")[], astProvider: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.AstProviderFn",
"text": "AstProviderFn"
},
", options: ",
"CodeActionOptions",
", resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CodeAction",
"text": "CodeAction"
},
"[]>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/actions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getActions.$1",
"type": "string",
"tags": [],
"label": "innerText",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/actions.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getActions.$2",
"type": "Array",
"tags": [],
"label": "markers",
"description": [],
"signature": [
"(",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
")[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/actions.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getActions.$3",
"type": "Function",
"tags": [],
"label": "astProvider",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.AstProviderFn",
"text": "AstProviderFn"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/actions.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getActions.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"CodeActionOptions"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/actions.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getActions.$5",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/actions.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllCommands",
"type": "Function",
"tags": [],
"label": "getAllCommands",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandDefinition",
"text": "CommandDefinition"
},
"[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllFunctions",
"type": "Function",
"tags": [],
"label": "getAllFunctions",
"description": [],
"signature": [
"(options: { type: \"agg\" | \"builtin\" | \"eval\" | (\"agg\" | \"builtin\" | \"eval\")[]; } | undefined) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
},
"[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllFunctions.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllFunctions.$1.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"agg\" | \"builtin\" | \"eval\" | (\"agg\" | \"builtin\" | \"eval\")[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAstContext",
"type": "Function",
"tags": [],
"label": "getAstContext",
"description": [
"\nGiven a ES|QL query string, its AST and the cursor position,\nit returns the type of context for the position (\"list\", \"function\", \"option\", \"setting\", \"expression\", \"newCommand\")\nplus the whole hierarchy of nodes (command, option, setting and actual position node) context.\n\nType details:\n* \"list\": the cursor is inside a \"in\" list of values (i.e. `a in (1, 2, <here>)`)\n* \"function\": the cursor is inside a function call (i.e. `fn(<here>)`)\n* \"option\": the cursor is inside a command option (i.e. `command ... by <here>`)\n* \"setting\": the cursor is inside a setting (i.e. `command _<here>`)\n* \"expression\": the cursor is inside a command expression (i.e. `command ... <here>` or `command a = ... <here>`)\n* \"newCommand\": the cursor is at the beginning of a new command (i.e. `command1 | command2 | <here>`)"
],
"signature": [
"(queryString: string, ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
", offset: number) => { type: \"value\"; command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
"; node: ",
"ESQLStringLiteral",
"; option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | undefined; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; } | { type: \"list\"; command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
"; node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>; option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | undefined; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; } | { type: \"function\"; command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
"; node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>; option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | undefined; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; } | { type: \"option\"; command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
"; node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLUnknownItem",
"; option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | undefined; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; } | { type: \"setting\"; command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
"; node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
"; option: undefined; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; } | { type: \"newCommand\"; command: undefined; node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLUnknownItem",
" | undefined; option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | undefined; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; } | { type: \"option\"; command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
"; node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLUnknownItem",
" | undefined; option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
"; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; } | { type: \"expression\"; command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
"; option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | undefined; node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLUnknownItem",
" | undefined; setting: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | undefined; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/context.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAstContext.$1",
"type": "string",
"tags": [],
"label": "queryString",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/context.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAstContext.$2",
"type": "Array",
"tags": [],
"label": "ast",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/context.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAstContext.$3",
"type": "number",
"tags": [],
"label": "offset",
"description": [],
"signature": [
"number"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/context.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getColumnForASTNode",
"type": "Function",
"tags": [],
"label": "getColumnForASTNode",
"description": [
"\nThis function returns the variable or field matching a column"
],
"signature": [
"(column: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
", { fields, variables }: Pick<",
"ReferenceMaps",
", \"fields\" | \"variables\">) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLRealField",
"text": "ESQLRealField"
},
" | ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLVariable",
"text": "ESQLVariable"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getColumnForASTNode.$1",
"type": "Object",
"tags": [],
"label": "column",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getColumnForASTNode.$2",
"type": "Object",
"tags": [],
"label": "{ fields, variables }",
"description": [],
"signature": [
"Pick<",
"ReferenceMaps",
", \"fields\" | \"variables\">"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getCommandDefinition",
"type": "Function",
"tags": [],
"label": "getCommandDefinition",
"description": [],
"signature": [
"(name: string) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandDefinition",
"text": "CommandDefinition"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getCommandDefinition.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getCommandOption",
"type": "Function",
"tags": [],
"label": "getCommandOption",
"description": [],
"signature": [
"(optionName: string) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandOptionsDefinition",
"text": "CommandOptionsDefinition"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getCommandOption.$1",
"type": "string",
"tags": [],
"label": "optionName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFieldsByTypeHelper",
"type": "Function",
"tags": [],
"label": "getFieldsByTypeHelper",
"description": [],
"signature": [
"(queryText: string, resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => { getFieldsByType: (expectedType?: string | string[], ignored?: string[]) => Promise<",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLRealField",
"text": "ESQLRealField"
},
"[]>; getFieldsMap: () => Promise<Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLRealField",
"text": "ESQLRealField"
},
">>; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFieldsByTypeHelper.$1",
"type": "string",
"tags": [],
"label": "queryText",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFieldsByTypeHelper.$2",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionDefinition",
"type": "Function",
"tags": [],
"label": "getFunctionDefinition",
"description": [],
"signature": [
"(name: string) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionDefinition.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures",
"type": "Function",
"tags": [],
"label": "getFunctionSignatures",
"description": [
"\nGiven a function definition, this function will return a list of function signatures\n\nIf withTypes is true, the function will return a formal function definition with all arguments typed.\nThis is used when generating the function signature for the monaco editor. If withTypes is false, you get\nan \"injectable\" version of the signature to be used to generate test cases."
],
"signature": [
"({ name, signatures }: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
},
", { withTypes, capitalize }: { withTypes: boolean; capitalize?: boolean | undefined; }) => { declaration: string; }[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$1",
"type": "Object",
"tags": [],
"label": "{ name, signatures }",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$2",
"type": "Object",
"tags": [],
"label": "{ withTypes, capitalize }",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$2.withTypes",
"type": "boolean",
"tags": [],
"label": "withTypes",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$2.capitalize",
"type": "CompoundType",
"tags": [],
"label": "capitalize",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getPolicyHelper",
"type": "Function",
"tags": [],
"label": "getPolicyHelper",
"description": [],
"signature": [
"(resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => { getPolicies: () => Promise<{ name: string; sourceIndices: string[]; matchField: string; enrichFields: string[]; }[]>; getPolicyMetadata: (policyName: string) => Promise<{ name: string; sourceIndices: string[]; matchField: string; enrichFields: string[]; } | undefined>; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getPolicyHelper.$1",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getSourcesHelper",
"type": "Function",
"tags": [],
"label": "getSourcesHelper",
"description": [],
"signature": [
"(resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => () => Promise<{ name: string; hidden: boolean; title?: string | undefined; dataStreams?: { name: string; title?: string | undefined; }[] | undefined; type?: string | undefined; }[]>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getSourcesHelper.$1",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignment",
"type": "Function",
"tags": [],
"label": "isAssignment",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignment.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignmentComplete",
"type": "Function",
"tags": [],
"label": "isAssignmentComplete",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | undefined) => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignmentComplete.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isColumnItem",
"type": "Function",
"tags": [],
"label": "isColumnItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isColumnItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isExpression",
"type": "Function",
"tags": [],
"label": "isExpression",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isExpression.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isFunctionItem",
"type": "Function",
"tags": [],
"label": "isFunctionItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isFunctionItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isLiteralItem",
"type": "Function",
"tags": [],
"label": "isLiteralItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isLiteralItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isOptionItem",
"type": "Function",
"tags": [],
"label": "isOptionItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isOptionItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSettingItem",
"type": "Function",
"tags": [],
"label": "isSettingItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSettingItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSingleItem",
"type": "Function",
"tags": [],
"label": "isSingleItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSingleItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSourceItem",
"type": "Function",
"tags": [],
"label": "isSourceItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSourceItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction",
"type": "Function",
"tags": [],
"label": "isSupportedFunction",
"description": [],
"signature": [
"(name: string, parentCommand: string | undefined, option: string | undefined) => { supported: boolean; reason: ",
"ReasonTypes",
" | undefined; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction.$2",
"type": "string",
"tags": [],
"label": "parentCommand",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction.$3",
"type": "string",
"tags": [],
"label": "option",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isTimeIntervalItem",
"type": "Function",
"tags": [],
"label": "isTimeIntervalItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isTimeIntervalItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.printFunctionSignature",
"type": "Function",
"tags": [],
"label": "printFunctionSignature",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.printFunctionSignature.$1",
"type": "Object",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText",
"type": "Function",
"tags": [],
"label": "shouldBeQuotedText",
"description": [],
"signature": [
"(text: string, { dashSupported }: { dashSupported?: boolean | undefined; }) => boolean"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText.$2",
"type": "Object",
"tags": [],
"label": "{ dashSupported }",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText.$2.dashSupported",
"type": "CompoundType",
"tags": [],
"label": "dashSupported",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest",
"type": "Function",
"tags": [],
"label": "suggest",
"description": [],
"signature": [
"(fullText: string, offset: number, context: ",
"EditorContext",
", astProvider: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.AstProviderFn",
"text": "AstProviderFn"
},
", resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.SuggestionRawDefinition",
"text": "SuggestionRawDefinition"
},
"[]>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$1",
"type": "string",
"tags": [],
"label": "fullText",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$2",
"type": "number",
"tags": [],
"label": "offset",
"description": [],
"signature": [
"number"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$3",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"EditorContext"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$4",
"type": "Function",
"tags": [],
"label": "astProvider",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.AstProviderFn",
"text": "AstProviderFn"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$5",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery",
"type": "Function",
"tags": [],
"label": "validateQuery",
"description": [
"\nES|QL validation public API\nIt takes a query string and returns a list of messages (errors and warnings) after validate\nThe astProvider is optional, but if not provided the default one from '@kbn/esql-validation-autocomplete' will be used.\nThis is useful for async loading the ES|QL parser and reduce the bundle size, or to swap grammar version.\nAs for the callbacks, while optional, the validation function will selectively ignore some errors types based on each callback missing."
],
"signature": [
"(queryString: string, astProvider: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.AstProviderFn",
"text": "AstProviderFn"
},
", options: ",
"ValidationOptions",
", callbacks: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => Promise<",
"ValidationResult",
">"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery.$1",
"type": "string",
"tags": [],
"label": "queryString",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery.$2",
"type": "Function",
"tags": [],
"label": "astProvider",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.AstProviderFn",
"text": "AstProviderFn"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ValidationOptions"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery.$4",
"type": "Object",
"tags": [],
"label": "callbacks",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.wrapAsEditorMessage",
"type": "Function",
"tags": [],
"label": "wrapAsEditorMessage",
"description": [],
"signature": [
"(type: \"error\" | \"warning\", messages: (",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
")[]) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.wrapAsEditorMessage.$1",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"error\" | \"warning\""
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.wrapAsEditorMessage.$2",
"type": "Array",
"tags": [],
"label": "messages",
"description": [],
"signature": [
"(",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
")[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CodeAction",
"type": "Interface",
"tags": [],
"label": "CodeAction",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CodeAction.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CodeAction.diagnostics",
"type": "Array",
"tags": [],
"label": "diagnostics",
"description": [],
"signature": [
"EditorError",
"[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CodeAction.kind",
"type": "string",
"tags": [],
"label": "kind",
"description": [],
"signature": [
"\"quickfix\""
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CodeAction.edits",
"type": "Array",
"tags": [],
"label": "edits",
"description": [],
"signature": [
"{ range: ",
"EditorError",
"; text: string; }[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/code_actions/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition",
"type": "Interface",
"tags": [],
"label": "CommandDefinition",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandDefinition",
"text": "CommandDefinition"
},
" extends ",
"CommandBaseDefinition"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.options",
"type": "Array",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandOptionsDefinition",
"text": "CommandOptionsDefinition"
},
"[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.examples",
"type": "Array",
"tags": [],
"label": "examples",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"((option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
"[]) | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.validate.$1",
"type": "Object",
"tags": [],
"label": "option",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.modes",
"type": "Array",
"tags": [],
"label": "modes",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandModeDefinition",
"text": "CommandModeDefinition"
},
"[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandModeDefinition",
"type": "Interface",
"tags": [],
"label": "CommandModeDefinition",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandModeDefinition.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandModeDefinition.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandModeDefinition.values",
"type": "Array",
"tags": [],
"label": "values",
"description": [],
"signature": [
"{ name: string; description: string; }[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandModeDefinition.prefix",
"type": "string",
"tags": [],
"label": "prefix",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition",
"type": "Interface",
"tags": [],
"label": "CommandOptionsDefinition",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandOptionsDefinition",
"text": "CommandOptionsDefinition"
},
" extends ",
"CommandBaseDefinition"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition.wrapped",
"type": "Array",
"tags": [],
"label": "wrapped",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition.optional",
"type": "boolean",
"tags": [],
"label": "optional",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition.skipCommonValidation",
"type": "CompoundType",
"tags": [],
"label": "skipCommonValidation",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"((option: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
", command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>, references?: unknown) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
"[]) | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition.validate.$1",
"type": "Object",
"tags": [],
"label": "option",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition.validate.$2",
"type": "Object",
"tags": [],
"label": "command",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandOptionsDefinition.validate.$3",
"type": "Unknown",
"tags": [],
"label": "references",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks",
"type": "Interface",
"tags": [],
"label": "ESQLCallbacks",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getSources",
"type": "Function",
"tags": [],
"label": "getSources",
"description": [],
"signature": [
"CallbackFn<{}, { name: string; hidden: boolean; title?: string | undefined; dataStreams?: { name: string; title?: string | undefined; }[] | undefined; type?: string | undefined; }> | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getFieldsFor",
"type": "Function",
"tags": [],
"label": "getFieldsFor",
"description": [],
"signature": [
"CallbackFn<{ query: string; }, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLRealField",
"text": "ESQLRealField"
},
"> | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getPolicies",
"type": "Function",
"tags": [],
"label": "getPolicies",
"description": [],
"signature": [
"CallbackFn<{}, { name: string; sourceIndices: string[]; matchField: string; enrichFields: string[]; }> | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getPreferences",
"type": "Function",
"tags": [],
"label": "getPreferences",
"description": [],
"signature": [
"(() => Promise<{ histogramBarTarget: number; }>) | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy",
"type": "Interface",
"tags": [],
"label": "ESQLPolicy",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.sourceIndices",
"type": "Array",
"tags": [],
"label": "sourceIndices",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.matchField",
"type": "string",
"tags": [],
"label": "matchField",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.enrichFields",
"type": "Array",
"tags": [],
"label": "enrichFields",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLRealField",
"type": "Interface",
"tags": [],
"label": "ESQLRealField",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLRealField.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLRealField.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"boolean\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"keyword\" | \"text\" | \"date\" | \"date_nanos\" | \"version\" | \"integer\" | \"long\" | \"double\" | \"unsigned_long\" | \"unsupported\" | \"cartesian_point\" | \"cartesian_shape\" | \"counter_integer\" | \"counter_long\" | \"counter_double\""
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLRealField.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ description?: string | undefined; } | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLVariable",
"type": "Interface",
"tags": [],
"label": "ESQLVariable",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLVariable.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLVariable.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLVariable.location",
"type": "Object",
"tags": [],
"label": "location",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLocation",
"text": "ESQLLocation"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition",
"type": "Interface",
"tags": [],
"label": "FunctionDefinition",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"agg\" | \"builtin\" | \"eval\""
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.ignoreAsSuggestion",
"type": "CompoundType",
"tags": [],
"label": "ignoreAsSuggestion",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.alias",
"type": "Array",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.supportedCommands",
"type": "Array",
"tags": [],
"label": "supportedCommands",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.supportedOptions",
"type": "Array",
"tags": [],
"label": "supportedOptions",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.signatures",
"type": "Array",
"tags": [],
"label": "signatures",
"description": [],
"signature": [
"{ params: { name: string; type: ",
"FunctionParameterType",
"; optional?: boolean | undefined; noNestingFunctions?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; literalOptions?: string[] | undefined; literalSuggestions?: string[] | undefined; }[]; minParams?: number | undefined; returnType: ",
"FunctionReturnType",
"; }[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.examples",
"type": "Array",
"tags": [],
"label": "examples",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"((fnDef: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
"[]) | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.validate.$1",
"type": "Object",
"tags": [],
"label": "fnDef",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.Literals",
"type": "Interface",
"tags": [],
"label": "Literals",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.Literals.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.Literals.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition",
"type": "Interface",
"tags": [],
"label": "SuggestionRawDefinition",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.filterText",
"type": "string",
"tags": [],
"label": "filterText",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.asSnippet",
"type": "CompoundType",
"tags": [],
"label": "asSnippet",
"description": [
"\nShould the text be inserted as a snippet?\nThat is usually used for special behaviour like moving the cursor in a specific position\nafter inserting the text.\ni.e. 'fnName( $0 )' will insert fnName( ) and move the cursor where $0 is."
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.kind",
"type": "CompoundType",
"tags": [],
"label": "kind",
"description": [
"\nThis is useful to identify the suggestion type and apply different styles to it."
],
"signature": [
"\"Value\" | \"Text\" | \"Operator\" | \"Field\" | \"Function\" | \"Method\" | \"Variable\" | \"Class\" | \"Constant\" | \"Keyword\" | \"Reference\" | \"Snippet\" | \"Issue\""
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.detail",
"type": "string",
"tags": [],
"label": "detail",
"description": [
"\nA very short description for the suggestion entry that can be shown on the UI next to the label"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.documentation",
"type": "Object",
"tags": [],
"label": "documentation",
"description": [
"\nA longer description for the suggestion entry that can be shown on demand on the UI."
],
"signature": [
"{ value: string; } | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.sortText",
"type": "string",
"tags": [],
"label": "sortText",
"description": [
"\nA string to use for sorting the suggestion within the suggestions list"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.command",
"type": "Object",
"tags": [],
"label": "command",
"description": [
"\nSuggestions can trigger a command by id. This is useful to trigger specific actions in some contexts"
],
"signature": [
"{ title: string; id: string; } | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.rangeToReplace",
"type": "Object",
"tags": [],
"label": "rangeToReplace",
"description": [
"\nThe range that should be replaced when the suggestion is applied"
],
"signature": [
"{ start: number; end: number; } | undefined"
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors",
"type": "Interface",
"tags": [],
"label": "ValidationErrors",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentType",
"type": "Object",
"tags": [],
"label": "wrongArgumentType",
"description": [],
"signature": [
"{ message: string; type: { name: string; argType: string; value: string | number | Date; givenType: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentNumber",
"type": "Object",
"tags": [],
"label": "wrongArgumentNumber",
"description": [],
"signature": [
"{ message: string; type: { fn: string; numArgs: number; passedArgs: number; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentNumberTooMany",
"type": "Object",
"tags": [],
"label": "wrongArgumentNumberTooMany",
"description": [],
"signature": [
"{ message: string; type: { fn: string; numArgs: number; passedArgs: number; extraArgs: number; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentNumberTooFew",
"type": "Object",
"tags": [],
"label": "wrongArgumentNumberTooFew",
"description": [],
"signature": [
"{ message: string; type: { fn: string; numArgs: number; passedArgs: number; missingArgs: number; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownColumn",
"type": "Object",
"tags": [],
"label": "unknownColumn",
"description": [],
"signature": [
"{ message: string; type: { name: string | number; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownFunction",
"type": "Object",
"tags": [],
"label": "unknownFunction",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownIndex",
"type": "Object",
"tags": [],
"label": "unknownIndex",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.noNestedArgumentSupport",
"type": "Object",
"tags": [],
"label": "noNestedArgumentSupport",
"description": [],
"signature": [
"{ message: string; type: { name: string; argType: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedFunctionForCommand",
"type": "Object",
"tags": [],
"label": "unsupportedFunctionForCommand",
"description": [],
"signature": [
"{ message: string; type: { name: string; command: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedFunctionForCommandOption",
"type": "Object",
"tags": [],
"label": "unsupportedFunctionForCommandOption",
"description": [],
"signature": [
"{ message: string; type: { name: string; command: string; option: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedLiteralOption",
"type": "Object",
"tags": [],
"label": "unsupportedLiteralOption",
"description": [],
"signature": [
"{ message: string; type: { name: string; value: string; supportedOptions: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.shadowFieldType",
"type": "Object",
"tags": [],
"label": "shadowFieldType",
"description": [],
"signature": [
"{ message: string; type: { field: string; fieldType: string; newType: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedColumnTypeForCommand",
"type": "Object",
"tags": [],
"label": "unsupportedColumnTypeForCommand",
"description": [],
"signature": [
"{ message: string; type: { command: string; type: string; typeCount: number; givenType: string; column: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownOption",
"type": "Object",
"tags": [],
"label": "unknownOption",
"description": [],
"signature": [
"{ message: string; type: { command: string; option: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongOptionArgumentType",
"type": "Object",
"tags": [],
"label": "wrongOptionArgumentType",
"description": [],
"signature": [
"{ message: string; type: { command: string; option: string; type: string; givenValue: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownInterval",
"type": "Object",
"tags": [],
"label": "unknownInterval",
"description": [],
"signature": [
"{ message: string; type: { value: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedTypeForCommand",
"type": "Object",
"tags": [],
"label": "unsupportedTypeForCommand",
"description": [],
"signature": [
"{ message: string; type: { command: string; value: string; type: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownPolicy",
"type": "Object",
"tags": [],
"label": "unknownPolicy",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownAggregateFunction",
"type": "Object",
"tags": [],
"label": "unknownAggregateFunction",
"description": [],
"signature": [
"{ message: string; type: { type: string; value: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wildcardNotSupportedForCommand",
"type": "Object",
"tags": [],
"label": "wildcardNotSupportedForCommand",
"description": [],
"signature": [
"{ message: string; type: { command: string; value: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.noWildcardSupportAsArg",
"type": "Object",
"tags": [],
"label": "noWildcardSupportAsArg",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedFieldType",
"type": "Object",
"tags": [],
"label": "unsupportedFieldType",
"description": [],
"signature": [
"{ message: string; type: { field: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedSetting",
"type": "Object",
"tags": [],
"label": "unsupportedSetting",
"description": [],
"signature": [
"{ message: string; type: { setting: string; expected: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedSettingCommandValue",
"type": "Object",
"tags": [],
"label": "unsupportedSettingCommandValue",
"description": [],
"signature": [
"{ message: string; type: { command: string; value: string; expected: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.expectedConstant",
"type": "Object",
"tags": [],
"label": "expectedConstant",
"description": [],
"signature": [
"{ message: string; type: { fn: string; given: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.metadataBracketsDeprecation",
"type": "Object",
"tags": [],
"label": "metadataBracketsDeprecation",
"description": [],
"signature": [
"{ message: string; type: {}; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownMetadataField",
"type": "Object",
"tags": [],
"label": "unknownMetadataField",
"description": [],
"signature": [
"{ message: string; type: { value: string; availableFields: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongDissectOptionArgumentType",
"type": "Object",
"tags": [],
"label": "wrongDissectOptionArgumentType",
"description": [],
"signature": [
"{ message: string; type: { value: string | number; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.noAggFunction",
"type": "Object",
"tags": [],
"label": "noAggFunction",
"description": [],
"signature": [
"{ message: string; type: { commandName: string; expression: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.expressionNotAggClosed",
"type": "Object",
"tags": [],
"label": "expressionNotAggClosed",
"description": [],
"signature": [
"{ message: string; type: { commandName: string; expression: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.aggInAggFunction",
"type": "Object",
"tags": [],
"label": "aggInAggFunction",
"description": [],
"signature": [
"{ message: string; type: { nestedAgg: string; }; }"
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ErrorTypes",
"type": "Type",
"tags": [],
"label": "ErrorTypes",
"description": [],
"signature": [
"keyof ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ValidationErrors",
"text": "ValidationErrors"
}
],
"path": "packages/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ItemKind",
"type": "Type",
"tags": [],
"label": "ItemKind",
"description": [],
"signature": [
"\"Value\" | \"Text\" | \"Operator\" | \"Field\" | \"Function\" | \"Method\" | \"Variable\" | \"Class\" | \"Constant\" | \"Keyword\" | \"Reference\" | \"Snippet\" | \"Issue\""
],
"path": "packages/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ENRICH_MODES",
"type": "Object",
"tags": [],
"label": "ENRICH_MODES",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/settings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ENRICH_MODES.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/settings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ENRICH_MODES.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/settings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ENRICH_MODES.prefix",
"type": "string",
"tags": [],
"label": "prefix",
"description": [],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/settings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ENRICH_MODES.values",
"type": "Array",
"tags": [],
"label": "values",
"description": [],
"signature": [
"{ name: string; description: string; }[]"
],
"path": "packages/kbn-esql-validation-autocomplete/src/definitions/settings.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}