kibana/api_docs/console.json

{
  "id": "console",
  "client": {
    "classes": [
      {
        "parentPluginId": "console",
        "id": "def-public.ConsoleUIPlugin",
        "type": "Class",
        "tags": [],
        "label": "ConsoleUIPlugin",
        "description": [],
        "signature": [
          {
            "pluginId": "console",
            "scope": "public",
            "docId": "kibConsolePluginApi",
            "section": "def-public.ConsoleUIPlugin",
            "text": "ConsoleUIPlugin"
          },
          " implements ",
          {
            "pluginId": "core",
            "scope": "public",
            "docId": "kibCorePluginApi",
            "section": "def-public.Plugin",
            "text": "Plugin"
          },
          "<void, void, ",
          "AppSetupUIPluginDependencies",
          ", object>"
        ],
        "path": "src/plugins/console/public/plugin.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "console",
            "id": "def-public.ConsoleUIPlugin.setup",
            "type": "Function",
            "tags": [],
            "label": "setup",
            "description": [],
            "signature": [
              "({ notifications, getStartServices, http }: ",
              {
                "pluginId": "core",
                "scope": "public",
                "docId": "kibCorePluginApi",
                "section": "def-public.CoreSetup",
                "text": "CoreSetup"
              },
              "<object, unknown>, { devTools, home, share, usageCollection }: ",
              "AppSetupUIPluginDependencies",
              ") => { locator: ",
              {
                "pluginId": "share",
                "scope": "common",
                "docId": "kibSharePluginApi",
                "section": "def-common.LocatorPublic",
                "text": "LocatorPublic"
              },
              "<",
              {
                "pluginId": "console",
                "scope": "public",
                "docId": "kibConsolePluginApi",
                "section": "def-public.ConsoleUILocatorParams",
                "text": "ConsoleUILocatorParams"
              },
              ">; }"
            ],
            "path": "src/plugins/console/public/plugin.ts",
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "console",
                "id": "def-public.ConsoleUIPlugin.setup.$1",
                "type": "Object",
                "tags": [],
                "label": "{ notifications, getStartServices, http }",
                "description": [],
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "public",
                    "docId": "kibCorePluginApi",
                    "section": "def-public.CoreSetup",
                    "text": "CoreSetup"
                  },
                  "<object, unknown>"
                ],
                "path": "src/plugins/console/public/plugin.ts",
                "deprecated": false,
                "isRequired": true
              },
              {
                "parentPluginId": "console",
                "id": "def-public.ConsoleUIPlugin.setup.$2",
                "type": "Object",
                "tags": [],
                "label": "{ devTools, home, share, usageCollection }",
                "description": [],
                "signature": [
                  "AppSetupUIPluginDependencies"
                ],
                "path": "src/plugins/console/public/plugin.ts",
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "console",
            "id": "def-public.ConsoleUIPlugin.start",
            "type": "Function",
            "tags": [],
            "label": "start",
            "description": [],
            "signature": [
              "() => void"
            ],
            "path": "src/plugins/console/public/plugin.ts",
            "deprecated": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "console",
        "id": "def-public.ConsoleUILocatorParams",
        "type": "Interface",
        "tags": [],
        "label": "ConsoleUILocatorParams",
        "description": [],
        "signature": [
          {
            "pluginId": "console",
            "scope": "public",
            "docId": "kibConsolePluginApi",
            "section": "def-public.ConsoleUILocatorParams",
            "text": "ConsoleUILocatorParams"
          },
          " extends ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "server",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-server.SerializableRecord",
            "text": "SerializableRecord"
          }
        ],
        "path": "src/plugins/console/public/plugin.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "console",
            "id": "def-public.ConsoleUILocatorParams.loadFrom",
            "type": "string",
            "tags": [],
            "label": "loadFrom",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/plugins/console/public/plugin.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "console",
      "id": "def-server.ConsoleSetup",
      "type": "Type",
      "tags": [],
      "label": "ConsoleSetup",
      "description": [],
      "signature": [
        "{ addExtensionSpecFilePath: (path: string) => void; }"
      ],
      "path": "src/plugins/console/server/types.ts",
      "deprecated": false,
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "console",
      "id": "def-server.ConsoleStart",
      "type": "Type",
      "tags": [],
      "label": "ConsoleStart",
      "description": [],
      "signature": [
        "{ addProcessorDefinition: (processor: unknown) => void; }"
      ],
      "path": "src/plugins/console/server/types.ts",
      "deprecated": false,
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}