github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_esql_ast.devdocs.json

6699 lines
No EOL
228 KiB
JSON
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"id": "@kbn/esql-ast",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter",
"type": "Class",
"tags": [],
"label": "BasicPrettyPrinter",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"ES|QL query AST to print."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"A single-line string representation of the query."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.multiline",
"type": "Function",
"tags": [],
"label": "multiline",
"description": [
"\nPrint a query with each command on a separate line. It is also possible to\nspecify a tabbing option for the pipe character.\n"
],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterMultilineOptions",
"text": "BasicPrettyPrinterMultilineOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.multiline.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"ES|QL query AST to print."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.multiline.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [
"Options for pretty-printing."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterMultilineOptions",
"text": "BasicPrettyPrinterMultilineOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"A multi-line string representation of the query."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.command",
"type": "Function",
"tags": [],
"label": "command",
"description": [],
"signature": [
"(command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.command.$1",
"type": "CompoundType",
"tags": [],
"label": "command",
"description": [
"ES|QL command AST node to print."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.command.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"Prints a single-line string representation of the command."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.expression",
"type": "Function",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"(expression: ",
"ESQLAstExpression",
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.expression.$1",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [
"ES|QL expression AST node to print."
],
"signature": [
"ESQLAstExpression"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.expression.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"Prints a single-line string representation of the expression."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.opts",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"{ multiline: boolean; pipeTab: string; lowercase: boolean; lowercaseCommands: boolean; lowercaseOptions: boolean; lowercaseFunctions: boolean; lowercaseKeywords: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.keyword",
"type": "Function",
"tags": [],
"label": "keyword",
"description": [],
"signature": [
"(word: string) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.keyword.$1",
"type": "string",
"tags": [],
"label": "word",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.decorateWithComments",
"type": "Function",
"tags": [],
"label": "decorateWithComments",
"description": [],
"signature": [
"(node: ",
"ESQLAstBaseItem",
"<string>, formatted: string) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.decorateWithComments.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.decorateWithComments.$2",
"type": "string",
"tags": [],
"label": "formatted",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.simplifyMultiplicationByOne",
"type": "Function",
"tags": [],
"label": "simplifyMultiplicationByOne",
"description": [],
"signature": [
"(node: ",
"ESQLAstExpression",
", minusCount?: number) => string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.simplifyMultiplicationByOne.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstExpression"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.simplifyMultiplicationByOne.$2",
"type": "number",
"tags": [],
"label": "minusCount",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.visitor",
"type": "Object",
"tags": [],
"label": "visitor",
"description": [],
"signature": [
"Visitor",
"<any, ",
"SharedData",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printCommand",
"type": "Function",
"tags": [],
"label": "printCommand",
"description": [],
"signature": [
"(command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printCommand.$1",
"type": "CompoundType",
"tags": [],
"label": "command",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printExpression",
"type": "Function",
"tags": [],
"label": "printExpression",
"description": [],
"signature": [
"(expression: ",
"ESQLAstExpression",
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printExpression.$1",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"ESQLAstExpression"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener",
"type": "Class",
"tags": [],
"label": "ESQLErrorListener",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLErrorListener",
"text": "ESQLErrorListener"
},
" extends ",
"ErrorListener",
"<any>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError",
"type": "Function",
"tags": [],
"label": "syntaxError",
"description": [],
"signature": [
"(recognizer: ",
"Recognizer",
"<any>, offendingSymbol: any, line: number, column: number, message: string, error: ",
"RecognitionException",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$1",
"type": "Object",
"tags": [],
"label": "recognizer",
"description": [],
"signature": [
"Recognizer",
"<any>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$2",
"type": "Any",
"tags": [],
"label": "offendingSymbol",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$3",
"type": "number",
"tags": [],
"label": "line",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$4",
"type": "number",
"tags": [],
"label": "column",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$5",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$6",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"RecognitionException",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.getErrors",
"type": "Function",
"tags": [],
"label": "getErrors",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery",
"type": "Class",
"tags": [],
"label": "EsqlQuery",
"description": [
"\nRepresents a parsed or programmatically created ES|QL query. Keeps track of\nthe AST, source code, and optionally lexer tokens."
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.fromSrc",
"type": "Function",
"tags": [],
"label": "fromSrc",
"description": [],
"signature": [
"(src: string, opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EsqlQuery",
"text": "EsqlQuery"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.fromSrc.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.fromSrc.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "ast",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$2",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$3",
"type": "Array",
"tags": [],
"label": "tokens",
"description": [],
"signature": [
"Token",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$4",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.print.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker",
"type": "Class",
"tags": [],
"label": "Walker",
"description": [
"\nIterates over all nodes in the AST and calls the appropriate visitor\nfunctions."
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [
"\nWalks the AST and calls the appropriate visitor functions."
],
"signature": [
"(node: ",
"WalkerAstNode",
", options: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Walker",
"text": "Walker"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"WalkerAstNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.commands",
"type": "Function",
"tags": [],
"label": "commands",
"description": [
"\nWalks the AST and extracts all command statements.\n"
],
"signature": [
"(node: Node) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.commands.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST node to extract parameters from."
],
"signature": [
"Node"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.params",
"type": "Function",
"tags": [],
"label": "params",
"description": [
"\nWalks the AST and extracts all parameter literals.\n"
],
"signature": [
"(node: ",
"WalkerAstNode",
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string>[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.params.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST node to extract parameters from."
],
"signature": [
"WalkerAstNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.find",
"type": "Function",
"tags": [],
"label": "find",
"description": [
"\nFinds and returns the first node that matches the search criteria.\n"
],
"signature": [
"(node: ",
"WalkerAstNode",
", predicate: (node: ",
"ESQLProperNode",
") => boolean) => ",
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.find.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST node to start the search from."
],
"signature": [
"WalkerAstNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.find.$2",
"type": "Function",
"tags": [],
"label": "predicate",
"description": [
"A function that returns true if the node matches the search criteria."
],
"signature": [
"(node: ",
"ESQLProperNode",
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"The first node that matches the search criteria."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findAll",
"type": "Function",
"tags": [],
"label": "findAll",
"description": [
"\nFinds and returns all nodes that match the search criteria.\n"
],
"signature": [
"(node: ",
"WalkerAstNode",
", predicate: (node: ",
"ESQLProperNode",
") => boolean) => ",
"ESQLProperNode",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findAll.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST node to start the search from."
],
"signature": [
"WalkerAstNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findAll.$2",
"type": "Function",
"tags": [],
"label": "predicate",
"description": [
"A function that returns true if the node matches the search criteria."
],
"signature": [
"(node: ",
"ESQLProperNode",
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"All nodes that match the search criteria."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.match",
"type": "Function",
"tags": [],
"label": "match",
"description": [
"\nMatches a single node against a template object. Returns the first node\nthat matches the template.\n"
],
"signature": [
"(node: ",
"WalkerAstNode",
", template: ",
"NodeMatchTemplate",
") => ",
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.match.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST node to match against the template."
],
"signature": [
"WalkerAstNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.match.$2",
"type": "Object",
"tags": [],
"label": "template",
"description": [
"Template object to match against the node."
],
"signature": [
"NodeMatchTemplate"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"The first node that matches the template"
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.matchAll",
"type": "Function",
"tags": [],
"label": "matchAll",
"description": [
"\nMatches all nodes against a template object. Returns all nodes that match\nthe template.\n"
],
"signature": [
"(node: ",
"WalkerAstNode",
", template: ",
"NodeMatchTemplate",
") => ",
"ESQLProperNode",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.matchAll.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST node to match against the template."
],
"signature": [
"WalkerAstNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.matchAll.$2",
"type": "Object",
"tags": [],
"label": "template",
"description": [
"Template object to match against the node."
],
"signature": [
"NodeMatchTemplate"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"All nodes that match the template"
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findFunction",
"type": "Function",
"tags": [],
"label": "findFunction",
"description": [
"\nFinds the first function that matches the predicate.\n"
],
"signature": [
"(node: ",
"WalkerAstNode",
", predicate: (node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => boolean) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findFunction.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST node from which to search for a function"
],
"signature": [
"WalkerAstNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findFunction.$2",
"type": "Function",
"tags": [],
"label": "predicate",
"description": [
"Callback function to determine if the function is found"
],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"The first function that matches the predicate"
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.hasFunction",
"type": "Function",
"tags": [],
"label": "hasFunction",
"description": [
"\nSearches for at least one occurrence of a function or expression in the AST.\n"
],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[], name: string) => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.hasFunction.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"AST subtree to search in."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.hasFunction.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [
"Function or expression name to search for."
],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"True if the function or expression is found in the AST."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.visitComments",
"type": "Function",
"tags": [],
"label": "visitComments",
"description": [],
"signature": [
"(root: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[], callback: (comment: ",
"ESQLAstComment",
", node: ",
"ESQLProperNode",
", attachment: keyof ",
"ESQLAstNodeFormatting",
") => void) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.visitComments.$1",
"type": "CompoundType",
"tags": [],
"label": "root",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.visitComments.$2",
"type": "Function",
"tags": [],
"label": "callback",
"description": [],
"signature": [
"(comment: ",
"ESQLAstComment",
", node: ",
"ESQLProperNode",
", attachment: keyof ",
"ESQLAstNodeFormatting",
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[] | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkCommand",
"type": "Function",
"tags": [],
"label": "walkCommand",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkCommand.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOption",
"type": "Function",
"tags": [],
"label": "walkOption",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOption.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkAstItem",
"type": "Function",
"tags": [],
"label": "walkAstItem",
"description": [],
"signature": [
"(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",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
"ESQLIdentifier",
" | ",
{
"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"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[] | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkAstItem.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"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",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
"ESQLIdentifier",
" | ",
{
"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"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[] | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMode",
"type": "Function",
"tags": [],
"label": "walkMode",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMode.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkListLiteral",
"type": "Function",
"tags": [],
"label": "walkListLiteral",
"description": [],
"signature": [
"(node: ",
"ESQLList",
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkListLiteral.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLList"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkColumn",
"type": "Function",
"tags": [],
"label": "walkColumn",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkColumn.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkInlineCast",
"type": "Function",
"tags": [],
"label": "walkInlineCast",
"description": [],
"signature": [
"(node: ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkInlineCast.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkFunction",
"type": "Function",
"tags": [],
"label": "walkFunction",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkFunction.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkQuery",
"type": "Function",
"tags": [],
"label": "walkQuery",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkQuery.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSingleAstItem",
"type": "Function",
"tags": [],
"label": "walkSingleAstItem",
"description": [],
"signature": [
"(node: ",
"ESQLAstExpression",
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSingleAstItem.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstExpression"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter",
"type": "Class",
"tags": [],
"label": "WrappingPrettyPrinter",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.opts",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"{ indent: string; tab: string; pipeTab: string; commandTab: string; multiline: boolean; wrap: number; lowercase: boolean; lowercaseCommands: boolean; lowercaseOptions: boolean; lowercaseFunctions: boolean; lowercaseKeywords: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.keyword",
"type": "Function",
"tags": [],
"label": "keyword",
"description": [],
"signature": [
"(word: string) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.keyword.$1",
"type": "string",
"tags": [],
"label": "word",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.printTopDecorations",
"type": "Function",
"tags": [],
"label": "printTopDecorations",
"description": [],
"signature": [
"(indent: string, node: ",
"ESQLAstBaseItem",
"<string>) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.printTopDecorations.$1",
"type": "string",
"tags": [],
"label": "indent",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.printTopDecorations.$2",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments",
"type": "Function",
"tags": [],
"label": "decorateWithComments",
"description": [],
"signature": [
"(indent: string, node: ",
"ESQLAstBaseItem",
"<string>, txt: string, indented?: boolean) => { txt: string; indented: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$1",
"type": "string",
"tags": [],
"label": "indent",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$2",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$3",
"type": "string",
"tags": [],
"label": "txt",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$4",
"type": "boolean",
"tags": [],
"label": "indented",
"description": [],
"signature": [
"boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.visitor",
"type": "Object",
"tags": [],
"label": "visitor",
"description": [],
"signature": [
"Visitor",
"<any, ",
"SharedData",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.createParser",
"type": "Function",
"tags": [],
"label": "createParser",
"description": [],
"signature": [
"(src: string) => { lexer: ",
"default",
"; tokens: ",
"CommonTokenStream",
"; parser: ",
"default",
"; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.createParser.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getLexer",
"type": "Function",
"tags": [],
"label": "getLexer",
"description": [],
"signature": [
"(inputStream: ",
"CharStream",
", errorListener: ",
"ErrorListener",
"<any>) => ",
"default"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getLexer.$1",
"type": "Object",
"tags": [],
"label": "inputStream",
"description": [],
"signature": [
"CharStream"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getLexer.$2",
"type": "Object",
"tags": [],
"label": "errorListener",
"description": [],
"signature": [
"ErrorListener",
"<any>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser",
"type": "Function",
"tags": [],
"label": "getParser",
"description": [],
"signature": [
"(inputStream: ",
"CharStream",
", errorListener: ",
"ErrorListener",
"<any>, parseListener?: ",
"default",
" | undefined) => { lexer: ",
"default",
"; tokens: ",
"CommonTokenStream",
"; parser: ",
"default",
"; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser.$1",
"type": "Object",
"tags": [],
"label": "inputStream",
"description": [],
"signature": [
"CharStream"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser.$2",
"type": "Object",
"tags": [],
"label": "errorListener",
"description": [],
"signature": [
"ErrorListener",
"<any>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser.$3",
"type": "Object",
"tags": [],
"label": "parseListener",
"description": [],
"signature": [
"default",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isBinaryExpression",
"type": "Function",
"tags": [],
"label": "isBinaryExpression",
"description": [
"\nReturns true if the given node is a binary expression, i.e. an operator\nsurrounded by two operands:\n\n```\n1 + 1\ncolumn LIKE \"foo\"\nfoo = \"bar\"\n```\n"
],
"signature": [
"(node: unknown) => node is ",
"ESQLBinaryExpression",
"<",
"BinaryExpressionOperator",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isBinaryExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [
"Any ES|QL AST node."
],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isColumn",
"type": "Function",
"tags": [],
"label": "isColumn",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isColumn.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isDoubleLiteral",
"type": "Function",
"tags": [],
"label": "isDoubleLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLIntegerLiteral"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isDoubleLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFieldExpression",
"type": "Function",
"tags": [],
"label": "isFieldExpression",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLBinaryExpression",
"<\"where\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFieldExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFunctionExpression",
"type": "Function",
"tags": [],
"label": "isFunctionExpression",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFunctionExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIdentifier",
"type": "Function",
"tags": [],
"label": "isIdentifier",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLIdentifier"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIdentifier.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIntegerLiteral",
"type": "Function",
"tags": [],
"label": "isIntegerLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLIntegerLiteral"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIntegerLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isLiteral",
"type": "Function",
"tags": [],
"label": "isLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isParamLiteral",
"type": "Function",
"tags": [],
"label": "isParamLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isParamLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isProperNode",
"type": "Function",
"tags": [],
"label": "isProperNode",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLProperNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isProperNode.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isSource",
"type": "Function",
"tags": [],
"label": "isSource",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isSource.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isWhereExpression",
"type": "Function",
"tags": [],
"label": "isWhereExpression",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLBinaryExpression",
"<\"where\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isWhereExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse",
"type": "Function",
"tags": [],
"label": "parse",
"description": [],
"signature": [
"(text: string | undefined, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseResult",
"text": "ParseResult"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse",
"type": "Function",
"tags": [],
"label": "parse",
"description": [],
"signature": [
"(text: string | undefined, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseResult",
"text": "ParseResult"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parseErrors",
"type": "Function",
"tags": [],
"label": "parseErrors",
"description": [],
"signature": [
"(text: string) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parseErrors.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [],
"signature": [
"(node: ",
"WalkerAstNode",
", options: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Walker",
"text": "Walker"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.walk.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.walk.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions",
"type": "Interface",
"tags": [],
"label": "BasicPrettyPrinterOptions",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.multiline",
"type": "CompoundType",
"tags": [],
"label": "multiline",
"description": [
"\nWhether to break the query into multiple lines on each pipe. Defaults to\n`false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.pipeTab",
"type": "string",
"tags": [],
"label": "pipeTab",
"description": [
"\nTabbing string inserted before a pipe, when `multiline` is `true`. Defaults\nto two spaces."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercase",
"type": "CompoundType",
"tags": [],
"label": "lowercase",
"description": [
"\nThe default lowercase setting to use for all options. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseCommands",
"type": "CompoundType",
"tags": [],
"label": "lowercaseCommands",
"description": [
"\nWhether to lowercase command names. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseOptions",
"type": "CompoundType",
"tags": [],
"label": "lowercaseOptions",
"description": [
"\nWhether to lowercase command options. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseFunctions",
"type": "CompoundType",
"tags": [],
"label": "lowercaseFunctions",
"description": [
"\nWhether to lowercase function names. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseKeywords",
"type": "CompoundType",
"tags": [],
"label": "lowercaseKeywords",
"description": [
"\nWhether to lowercase keywords. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError",
"type": "Interface",
"tags": [],
"label": "EditorError",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.startLineNumber",
"type": "number",
"tags": [],
"label": "startLineNumber",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.endLineNumber",
"type": "number",
"tags": [],
"label": "endLineNumber",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.startColumn",
"type": "number",
"tags": [],
"label": "startColumn",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.endColumn",
"type": "number",
"tags": [],
"label": "endColumn",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.severity",
"type": "CompoundType",
"tags": [],
"label": "severity",
"description": [],
"signature": [
"number | \"error\" | \"warning\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand",
"type": "Interface",
"tags": [],
"label": "ESQLAstMetricsCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<\"metrics\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand.sources",
"type": "Array",
"tags": [],
"label": "sources",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand.aggregates",
"type": "Array",
"tags": [],
"label": "aggregates",
"description": [],
"signature": [
"ESQLAstField",
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand.grouping",
"type": "Array",
"tags": [],
"label": "grouping",
"description": [],
"signature": [
"ESQLAstField",
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstQueryExpression",
"type": "Interface",
"tags": [],
"label": "ESQLAstQueryExpression",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" extends ",
"ESQLAstBaseItem",
"<\"\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstQueryExpression.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"query\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstQueryExpression.commands",
"type": "Array",
"tags": [],
"label": "commands",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn",
"type": "Interface",
"tags": [],
"label": "ESQLColumn",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"column\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [
"\nA ES|QL column name can be composed of multiple parts,\ne.g: part1.part2.`part``3️⃣`.?param. Where parts can be quoted, or not\nquoted, or even be a parameter.\n\nThe args list contains the parts of the column name."
],
"signature": [
"(",
"ESQLIdentifier",
" | ",
"ESQLParam",
")[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.parts",
"type": "Array",
"tags": [],
"label": "parts",
"description": [
"\nAn identifier can be composed of multiple parts, e.g: part1.part2.`part``3️⃣`.\nThis property contains the parsed unquoted parts of the identifier.\nFor example: `['part1', 'part2', 'part`3️⃣']`."
],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.quoted",
"type": "boolean",
"tags": [
"deprecated"
],
"label": "quoted",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts"
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand",
"type": "Interface",
"tags": [],
"label": "ESQLCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<Name> extends ",
"ESQLAstBaseItem",
"<Name>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"command\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand.commandType",
"type": "string",
"tags": [],
"label": "commandType",
"description": [
"\nThe subtype of the command. For example, the `JOIN` command can be: (1)\nLOOKUP JOIN, (2) LEFT JOIN, (3) RIGHT JOIN."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandMode",
"type": "Interface",
"tags": [],
"label": "ESQLCommandMode",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandMode.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"mode\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandOption",
"type": "Interface",
"tags": [],
"label": "ESQLCommandOption",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandOption.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"option\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandOption.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction",
"type": "Interface",
"tags": [],
"label": "ESQLFunction",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<Subtype, Name> extends ",
"ESQLAstBaseItem",
"<Name>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"function\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.subtype",
"type": "Uncategorized",
"tags": [],
"label": "subtype",
"description": [
"\nDefault is 'variadic-call'."
],
"signature": [
"Subtype | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [
"\nA node representing the function or operator being called."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
"ESQLIdentifier",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLocation",
"type": "Interface",
"tags": [],
"label": "ESQLLocation",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLocation.min",
"type": "number",
"tags": [],
"label": "min",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLocation.max",
"type": "number",
"tags": [],
"label": "max",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage",
"type": "Interface",
"tags": [],
"label": "ESQLMessage",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"error\" | \"warning\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.location",
"type": "Object",
"tags": [],
"label": "location",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLocation",
"text": "ESQLLocation"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral",
"type": "Interface",
"tags": [],
"label": "ESQLParamLiteral",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<ParamType> extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"literal\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.literalType",
"type": "string",
"tags": [],
"label": "literalType",
"description": [],
"signature": [
"\"param\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.paramType",
"type": "Uncategorized",
"tags": [],
"label": "paramType",
"description": [],
"signature": [
"ParamType"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource",
"type": "Interface",
"tags": [],
"label": "ESQLSource",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"source\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.sourceType",
"type": "CompoundType",
"tags": [],
"label": "sourceType",
"description": [],
"signature": [
"\"index\" | \"policy\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.cluster",
"type": "string",
"tags": [],
"label": "cluster",
"description": [
"\nRepresents the cluster part of the source identifier. Empty string if not\npresent.\n\n```\nFROM [<cluster>:]<index>\n```"
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.index",
"type": "string",
"tags": [],
"label": "index",
"description": [
"\nRepresents the index part of the source identifier. Unescaped and unquoted.\n\n```\nFROM [<cluster>:]<index>\n```"
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval",
"type": "Interface",
"tags": [],
"label": "ESQLTimeInterval",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval.type",
"type": "string",
"tags": [
"todo"
],
"label": "type",
"description": [],
"signature": [
"\"timeInterval\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval.unit",
"type": "string",
"tags": [],
"label": "unit",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval.quantity",
"type": "number",
"tags": [],
"label": "quantity",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseOptions",
"type": "Interface",
"tags": [],
"label": "ParseOptions",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseOptions.withFormatting",
"type": "CompoundType",
"tags": [],
"label": "withFormatting",
"description": [
"\nWhether to collect and attach to AST nodes user's custom formatting:\ncomments and whitespace."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult",
"type": "Interface",
"tags": [],
"label": "ParseResult",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.root",
"type": "Object",
"tags": [],
"label": "root",
"description": [
"\nThe root *QueryExpression* node of the parsed tree."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.ast",
"type": "Array",
"tags": [
"deprecated"
],
"label": "ast",
"description": [
"\nList of parsed commands.\n"
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_with_safe_limit.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts"
}
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.tokens",
"type": "Array",
"tags": [],
"label": "tokens",
"description": [
"\nList of ANTLR tokens generated by the lexer."
],
"signature": [
"Token",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [
"\nList of parsing errors."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions",
"type": "Interface",
"tags": [],
"label": "WalkerOptions",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommand",
"type": "Function",
"tags": [],
"label": "visitCommand",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>) => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommand.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandOption",
"type": "Function",
"tags": [],
"label": "visitCommandOption",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandOption.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandMode",
"type": "Function",
"tags": [],
"label": "visitCommandMode",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandMode.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSingleAstItem",
"type": "Function",
"tags": [
"todo"
],
"label": "visitSingleAstItem",
"description": [],
"signature": [
"((node: ",
"ESQLAstExpression",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSingleAstItem.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstExpression"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitQuery",
"type": "Function",
"tags": [],
"label": "visitQuery",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitQuery.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitFunction",
"type": "Function",
"tags": [],
"label": "visitFunction",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitFunction.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSource",
"type": "Function",
"tags": [],
"label": "visitSource",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSource.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitColumn",
"type": "Function",
"tags": [],
"label": "visitColumn",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitColumn.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitLiteral",
"type": "Function",
"tags": [],
"label": "visitLiteral",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitLiteral.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitListLiteral",
"type": "Function",
"tags": [],
"label": "visitListLiteral",
"description": [],
"signature": [
"((node: ",
"ESQLList",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitListLiteral.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLList"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitTimeIntervalLiteral",
"type": "Function",
"tags": [],
"label": "visitTimeIntervalLiteral",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitTimeIntervalLiteral.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitInlineCast",
"type": "Function",
"tags": [],
"label": "visitInlineCast",
"description": [],
"signature": [
"((node: ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">) => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitInlineCast.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitUnknown",
"type": "Function",
"tags": [],
"label": "visitUnknown",
"description": [],
"signature": [
"((node: ",
"ESQLUnknownItem",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitUnknown.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLUnknownItem"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitIdentifier",
"type": "Function",
"tags": [],
"label": "visitIdentifier",
"description": [],
"signature": [
"((node: ",
"ESQLIdentifier",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitIdentifier.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLIdentifier"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitAny",
"type": "Function",
"tags": [],
"label": "visitAny",
"description": [
"\nCalled for any node type that does not have a specific visitor.\n"
],
"signature": [
"((node: ",
"ESQLProperNode",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitAny.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"Any valid AST node."
],
"signature": [
"ESQLProperNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions",
"type": "Interface",
"tags": [],
"label": "WrappingPrettyPrinterOptions",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.indent",
"type": "string",
"tags": [],
"label": "indent",
"description": [
"\nInitial indentation string inserted before the whole query. Defaults to an\nempty string."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.tab",
"type": "string",
"tags": [],
"label": "tab",
"description": [
"\nTabbing string inserted before new level of nesting. Defaults to two spaces."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.pipeTab",
"type": "string",
"tags": [],
"label": "pipeTab",
"description": [
"\nTabbing string inserted before a pipe, when `multiline` is `true`."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.commandTab",
"type": "string",
"tags": [],
"label": "commandTab",
"description": [
"\nTabbing string inserted before command arguments, when they are broken into\nmultiple lines. Defaults to four spaces."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.multiline",
"type": "CompoundType",
"tags": [],
"label": "multiline",
"description": [
"\nWhether to force multiline formatting. Defaults to `false`. If set to\n`false`, it will try to fit the query into a single line."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.wrap",
"type": "number",
"tags": [],
"label": "wrap",
"description": [
"\nExpected width of the output. Defaults to 80 characters. Text will be\nwrapped to fit this width."
],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstNodeParserFields",
"type": "Type",
"tags": [],
"label": "AstNodeParserFields",
"description": [
"\nNode fields which are available only when the node is minted by the parser.\nWhen creating nodes manually, these fields are not available."
],
"signature": [
"{ text: string; location: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLocation",
"text": "ESQLLocation"
},
"; incomplete: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/builder/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstNodeTemplate",
"type": "Type",
"tags": [],
"label": "AstNodeTemplate",
"description": [
"\nThe node *template* transforms ES|QL AST nodes into a permissive shape, with\nthe aim to:\n\n- Remove the `type` property, as the builder will set it.\n- Make properties like `text`, `location`, and `incomplete` optional, as they\n are a available only when the AST node is minted by the parser.\n- Make all other properties optional, for easy node creation."
],
"signature": [
"Omit<Node, \"type\" | \"text\" | \"location\" | \"incomplete\"> & Partial<Omit<Node, \"type\">>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/builder/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstProviderFn",
"type": "Type",
"tags": [],
"label": "AstProviderFn",
"description": [],
"signature": [
"(text: string | undefined) => Promise<{ ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
"; errors: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]; }> | { ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
"; errors: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstProviderFn.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterMultilineOptions",
"type": "Type",
"tags": [],
"label": "BasicPrettyPrinterMultilineOptions",
"description": [],
"signature": [
"{ lowercase?: boolean | undefined; pipeTab?: string | undefined; lowercaseCommands?: boolean | undefined; lowercaseOptions?: boolean | undefined; lowercaseFunctions?: boolean | undefined; lowercaseKeywords?: boolean | undefined; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAst",
"type": "Type",
"tags": [],
"label": "ESQLAst",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstCommand",
"type": "Type",
"tags": [],
"label": "ESQLAstCommand",
"description": [],
"signature": [
{
"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"
},
" | ",
"ESQLAstJoinCommand"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstItem",
"type": "Type",
"tags": [],
"label": "ESQLAstItem",
"description": [
"\nAn array of AST nodes represents different things in different contexts.\nFor example, in command top level arguments it is treated as an \"assignment expression\"."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstNode",
"type": "Type",
"tags": [],
"label": "ESQLAstNode",
"description": [],
"signature": [
{
"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"
},
" | ",
"ESQLAstJoinCommand",
" | ",
{
"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",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string> | ",
"ESQLIdentifier",
" | ",
{
"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"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[] | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLiteral",
"type": "Type",
"tags": [],
"label": "ESQLLiteral",
"description": [],
"signature": [
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSingleAstItem",
"type": "Type",
"tags": [],
"label": "ESQLSingleAstItem",
"description": [],
"signature": [
{
"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",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
},
" | ",
"ESQLIdentifier",
" | ",
{
"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"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Builder",
"type": "Object",
"tags": [],
"label": "Builder",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Builder",
"text": "Builder"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/builder/builder.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter",
"type": "Object",
"tags": [],
"label": "LeafPrinter",
"description": [
"\nPrinter for leaf AST nodes. The printing output of these nodes should\ntypically not depend on word wrapping settings, should always return an\natomic short string."
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.source",
"type": "Function",
"tags": [],
"label": "source",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.source.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.identifier",
"type": "Function",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
"(node: ",
"ESQLIdentifier",
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.identifier.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLIdentifier"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.column",
"type": "Function",
"tags": [],
"label": "column",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.column.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.string",
"type": "Function",
"tags": [],
"label": "string",
"description": [],
"signature": [
"(node: ",
"ESQLStringLiteral",
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.string.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLStringLiteral"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.literal",
"type": "Function",
"tags": [],
"label": "literal",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.literal.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.param",
"type": "Function",
"tags": [],
"label": "param",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string>) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.param.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.timeInterval",
"type": "Function",
"tags": [],
"label": "timeInterval",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.timeInterval.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.comment",
"type": "Function",
"tags": [],
"label": "comment",
"description": [],
"signature": [
"(node: ",
"ESQLAstComment",
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.comment.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstComment"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.commentList",
"type": "Function",
"tags": [],
"label": "commentList",
"description": [],
"signature": [
"(comments: ",
"ESQLAstCommentMultiLine",
"[]) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.commentList.$1",
"type": "Array",
"tags": [],
"label": "comments",
"description": [],
"signature": [
"ESQLAstCommentMultiLine",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(node: ",
"ESQLProperNode",
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.print.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLProperNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink