kibana/api_docs/kbn_monaco.devdocs.json

{
  "id": "@kbn/monaco",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.registerLanguage",
        "type": "Function",
        "tags": [],
        "label": "registerLanguage",
        "description": [],
        "signature": [
          "(language: ",
          {
            "pluginId": "@kbn/monaco",
            "scope": "common",
            "docId": "kibKbnMonacoPluginApi",
            "section": "def-common.LangModuleType",
            "text": "LangModuleType"
          },
          ") => void"
        ],
        "path": "packages/kbn-monaco/src/helpers.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.registerLanguage.$1",
            "type": "Object",
            "tags": [],
            "label": "language",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.LangModuleType",
                "text": "LangModuleType"
              }
            ],
            "path": "packages/kbn-monaco/src/helpers.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.CompleteLangModuleType",
        "type": "Interface",
        "tags": [],
        "label": "CompleteLangModuleType",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/monaco",
            "scope": "common",
            "docId": "kibKbnMonacoPluginApi",
            "section": "def-common.CompleteLangModuleType",
            "text": "CompleteLangModuleType"
          },
          " extends ",
          {
            "pluginId": "@kbn/monaco",
            "scope": "common",
            "docId": "kibKbnMonacoPluginApi",
            "section": "def-common.LangModuleType",
            "text": "LangModuleType"
          }
        ],
        "path": "packages/kbn-monaco/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.CompleteLangModuleType.languageConfiguration",
            "type": "Object",
            "tags": [],
            "label": "languageConfiguration",
            "description": [],
            "signature": [
              "languages",
              ".LanguageConfiguration"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.CompleteLangModuleType.getSuggestionProvider",
            "type": "Object",
            "tags": [],
            "label": "getSuggestionProvider",
            "description": [],
            "signature": [
              "Function"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.CompleteLangModuleType.getSyntaxErrors",
            "type": "Object",
            "tags": [],
            "label": "getSyntaxErrors",
            "description": [],
            "signature": [
              "Function"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.CompleteLangModuleType.validation$",
            "type": "Function",
            "tags": [],
            "label": "validation$",
            "description": [],
            "signature": [
              "() => ",
              "Observable",
              "<",
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.LangValidation",
                "text": "LangValidation"
              },
              ">"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.EditorError",
        "type": "Interface",
        "tags": [],
        "label": "EditorError",
        "description": [],
        "path": "packages/kbn-monaco/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.EditorError.startLineNumber",
            "type": "number",
            "tags": [],
            "label": "startLineNumber",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.EditorError.startColumn",
            "type": "number",
            "tags": [],
            "label": "startColumn",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.EditorError.endLineNumber",
            "type": "number",
            "tags": [],
            "label": "endLineNumber",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.EditorError.endColumn",
            "type": "number",
            "tags": [],
            "label": "endColumn",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.EditorError.message",
            "type": "string",
            "tags": [],
            "label": "message",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.LangModuleType",
        "type": "Interface",
        "tags": [],
        "label": "LangModuleType",
        "description": [],
        "path": "packages/kbn-monaco/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangModuleType.ID",
            "type": "string",
            "tags": [],
            "label": "ID",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangModuleType.lexerRules",
            "type": "Object",
            "tags": [],
            "label": "lexerRules",
            "description": [],
            "signature": [
              "languages",
              ".IMonarchLanguage"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangModuleType.languageConfiguration",
            "type": "Object",
            "tags": [],
            "label": "languageConfiguration",
            "description": [],
            "signature": [
              "languages",
              ".LanguageConfiguration | undefined"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangModuleType.getSuggestionProvider",
            "type": "Object",
            "tags": [],
            "label": "getSuggestionProvider",
            "description": [],
            "signature": [
              "Function | undefined"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangModuleType.getSyntaxErrors",
            "type": "Object",
            "tags": [],
            "label": "getSyntaxErrors",
            "description": [],
            "signature": [
              "Function | undefined"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.LangValidation",
        "type": "Interface",
        "tags": [],
        "label": "LangValidation",
        "description": [],
        "path": "packages/kbn-monaco/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangValidation.isValidating",
            "type": "boolean",
            "tags": [],
            "label": "isValidating",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangValidation.isValid",
            "type": "boolean",
            "tags": [],
            "label": "isValid",
            "description": [],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.LangValidation.errors",
            "type": "Array",
            "tags": [],
            "label": "errors",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.EditorError",
                "text": "EditorError"
              },
              "[]"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.PainlessAutocompleteField",
        "type": "Interface",
        "tags": [],
        "label": "PainlessAutocompleteField",
        "description": [],
        "path": "packages/kbn-monaco/src/painless/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessAutocompleteField.name",
            "type": "string",
            "tags": [],
            "label": "name",
            "description": [],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessAutocompleteField.type",
            "type": "string",
            "tags": [],
            "label": "type",
            "description": [],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.PainlessCompletionItem",
        "type": "Interface",
        "tags": [],
        "label": "PainlessCompletionItem",
        "description": [],
        "path": "packages/kbn-monaco/src/painless/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessCompletionItem.label",
            "type": "string",
            "tags": [],
            "label": "label",
            "description": [],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessCompletionItem.kind",
            "type": "CompoundType",
            "tags": [],
            "label": "kind",
            "description": [],
            "signature": [
              "\"type\" | \"method\" | \"keyword\" | \"field\" | \"property\" | \"class\" | \"constructor\""
            ],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessCompletionItem.documentation",
            "type": "string",
            "tags": [],
            "label": "documentation",
            "description": [],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessCompletionItem.insertText",
            "type": "string",
            "tags": [],
            "label": "insertText",
            "description": [],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessCompletionItem.insertTextAsSnippet",
            "type": "CompoundType",
            "tags": [],
            "label": "insertTextAsSnippet",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.PainlessCompletionResult",
        "type": "Interface",
        "tags": [],
        "label": "PainlessCompletionResult",
        "description": [],
        "path": "packages/kbn-monaco/src/painless/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessCompletionResult.isIncomplete",
            "type": "boolean",
            "tags": [],
            "label": "isIncomplete",
            "description": [],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessCompletionResult.suggestions",
            "type": "Array",
            "tags": [],
            "label": "suggestions",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.PainlessCompletionItem",
                "text": "PainlessCompletionItem"
              },
              "[]"
            ],
            "path": "packages/kbn-monaco/src/painless/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.SyntaxErrors",
        "type": "Interface",
        "tags": [],
        "label": "SyntaxErrors",
        "description": [],
        "path": "packages/kbn-monaco/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.SyntaxErrors.Unnamed",
            "type": "IndexSignature",
            "tags": [],
            "label": "[modelId: string]: EditorError[]",
            "description": [],
            "signature": [
              "[modelId: string]:  ",
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.EditorError",
                "text": "EditorError"
              },
              "[]"
            ],
            "path": "packages/kbn-monaco/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.PainlessCompletionKind",
        "type": "Type",
        "tags": [],
        "label": "PainlessCompletionKind",
        "description": [],
        "signature": [
          "\"type\" | \"method\" | \"keyword\" | \"field\" | \"property\" | \"class\" | \"constructor\""
        ],
        "path": "packages/kbn-monaco/src/painless/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.PainlessContext",
        "type": "Type",
        "tags": [],
        "label": "PainlessContext",
        "description": [],
        "signature": [
          "\"filter\" | \"score\" | \"painless_test\" | \"boolean_script_field_script_field\" | \"date_script_field\" | \"double_script_field_script_field\" | \"ip_script_field_script_field\" | \"long_script_field_script_field\" | \"processor_conditional\" | \"string_script_field_script_field\""
        ],
        "path": "packages/kbn-monaco/src/painless/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.EsqlLang",
        "type": "Object",
        "tags": [],
        "label": "EsqlLang",
        "description": [],
        "path": "packages/kbn-monaco/src/esql/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.EsqlLang.ID",
            "type": "string",
            "tags": [],
            "label": "ID",
            "description": [],
            "path": "packages/kbn-monaco/src/esql/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.EsqlLang.lexerRules",
            "type": "Object",
            "tags": [],
            "label": "lexerRules",
            "description": [],
            "signature": [
              "languages",
              ".IMonarchLanguage"
            ],
            "path": "packages/kbn-monaco/src/esql/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.PainlessLang",
        "type": "Object",
        "tags": [],
        "label": "PainlessLang",
        "description": [],
        "path": "packages/kbn-monaco/src/painless/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessLang.ID",
            "type": "string",
            "tags": [],
            "label": "ID",
            "description": [],
            "path": "packages/kbn-monaco/src/painless/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessLang.getSuggestionProvider",
            "type": "Function",
            "tags": [],
            "label": "getSuggestionProvider",
            "description": [],
            "signature": [
              "(context: ",
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.PainlessContext",
                "text": "PainlessContext"
              },
              ", fields?: ",
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.PainlessAutocompleteField",
                "text": "PainlessAutocompleteField"
              },
              "[] | undefined) => ",
              "PainlessCompletionAdapter"
            ],
            "path": "packages/kbn-monaco/src/painless/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "returnComment": [],
            "children": [
              {
                "parentPluginId": "@kbn/monaco",
                "id": "def-common.PainlessLang.getSuggestionProvider.$1",
                "type": "CompoundType",
                "tags": [],
                "label": "context",
                "description": [],
                "signature": [
                  "\"filter\" | \"score\" | \"painless_test\" | \"boolean_script_field_script_field\" | \"date_script_field\" | \"double_script_field_script_field\" | \"ip_script_field_script_field\" | \"long_script_field_script_field\" | \"processor_conditional\" | \"string_script_field_script_field\""
                ],
                "path": "packages/kbn-monaco/src/painless/language.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/monaco",
                "id": "def-common.PainlessLang.getSuggestionProvider.$2",
                "type": "Array",
                "tags": [],
                "label": "fields",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/monaco",
                    "scope": "common",
                    "docId": "kibKbnMonacoPluginApi",
                    "section": "def-common.PainlessAutocompleteField",
                    "text": "PainlessAutocompleteField"
                  },
                  "[] | undefined"
                ],
                "path": "packages/kbn-monaco/src/painless/language.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessLang.lexerRules",
            "type": "Object",
            "tags": [],
            "label": "lexerRules",
            "description": [],
            "signature": [
              "Language"
            ],
            "path": "packages/kbn-monaco/src/painless/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessLang.languageConfiguration",
            "type": "Object",
            "tags": [],
            "label": "languageConfiguration",
            "description": [],
            "signature": [
              "languages",
              ".LanguageConfiguration"
            ],
            "path": "packages/kbn-monaco/src/painless/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessLang.getSyntaxErrors",
            "type": "Function",
            "tags": [],
            "label": "getSyntaxErrors",
            "description": [],
            "signature": [
              "() => ",
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.SyntaxErrors",
                "text": "SyntaxErrors"
              }
            ],
            "path": "packages/kbn-monaco/src/painless/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "returnComment": [],
            "children": []
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.PainlessLang.validation$",
            "type": "Function",
            "tags": [],
            "label": "validation$",
            "description": [],
            "signature": [
              "() => ",
              "Observable",
              "<",
              {
                "pluginId": "@kbn/monaco",
                "scope": "common",
                "docId": "kibKbnMonacoPluginApi",
                "section": "def-common.LangValidation",
                "text": "LangValidation"
              },
              ">"
            ],
            "path": "packages/kbn-monaco/src/painless/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "returnComment": [],
            "children": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/monaco",
        "id": "def-common.XJsonLang",
        "type": "Object",
        "tags": [],
        "label": "XJsonLang",
        "description": [],
        "path": "packages/kbn-monaco/src/xjson/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.XJsonLang.ID",
            "type": "string",
            "tags": [],
            "label": "ID",
            "description": [],
            "path": "packages/kbn-monaco/src/xjson/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.XJsonLang.lexerRules",
            "type": "Object",
            "tags": [],
            "label": "lexerRules",
            "description": [],
            "signature": [
              "languages",
              ".IMonarchLanguage"
            ],
            "path": "packages/kbn-monaco/src/xjson/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/monaco",
            "id": "def-common.XJsonLang.languageConfiguration",
            "type": "Object",
            "tags": [],
            "label": "languageConfiguration",
            "description": [],
            "signature": [
              "languages",
              ".LanguageConfiguration"
            ],
            "path": "packages/kbn-monaco/src/xjson/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}