kibana/api_docs/kbn_scout.devdocs.json

{
  "id": "@kbn/scout",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.Client",
        "type": "Class",
        "tags": [],
        "label": "Client",
        "description": [],
        "signature": [
          "default",
          " extends ",
          "default"
        ],
        "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.diagnostic",
            "type": "Object",
            "tags": [],
            "label": "diagnostic",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.name",
            "type": "CompoundType",
            "tags": [],
            "label": "name",
            "description": [],
            "signature": [
              "string | symbol"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.connectionPool",
            "type": "Object",
            "tags": [],
            "label": "connectionPool",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.transport",
            "type": "Object",
            "tags": [],
            "label": "transport",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.serializer",
            "type": "Object",
            "tags": [],
            "label": "serializer",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.helpers",
            "type": "Object",
            "tags": [],
            "label": "helpers",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.Client.Unnamed.$1",
                "type": "Object",
                "tags": [],
                "label": "opts",
                "description": [],
                "signature": [
                  "ClientOptions"
                ],
                "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.child",
            "type": "Function",
            "tags": [
              "see"
            ],
            "label": "child",
            "description": [
              "\nCreates a child client instance that shared its connection pool with the parent client"
            ],
            "signature": [
              "(opts: ",
              "ClientOptions",
              ") => ",
              "default"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.Client.child.$1",
                "type": "Object",
                "tags": [],
                "label": "opts",
                "description": [],
                "signature": [
                  "ClientOptions"
                ],
                "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.Client.close",
            "type": "Function",
            "tags": [],
            "label": "close",
            "description": [
              "\nCloses all connections in the connection pool. Connections shared with any parent or child instances will also be closed."
            ],
            "signature": [
              "() => Promise<void>"
            ],
            "path": "node_modules/@elastic/elasticsearch/lib/client.d.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.KbnClient",
        "type": "Class",
        "tags": [],
        "label": "KbnClient",
        "description": [],
        "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.status",
            "type": "Object",
            "tags": [],
            "label": "status",
            "description": [],
            "signature": [
              "KbnClientStatus"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.plugins",
            "type": "Object",
            "tags": [],
            "label": "plugins",
            "description": [],
            "signature": [
              "KbnClientPlugins"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.version",
            "type": "Object",
            "tags": [],
            "label": "version",
            "description": [],
            "signature": [
              "KbnClientVersion"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.savedObjects",
            "type": "Object",
            "tags": [],
            "label": "savedObjects",
            "description": [],
            "signature": [
              "KbnClientSavedObjects"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.spaces",
            "type": "Object",
            "tags": [],
            "label": "spaces",
            "description": [],
            "signature": [
              "KbnClientSpaces"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.uiSettings",
            "type": "Object",
            "tags": [],
            "label": "uiSettings",
            "description": [],
            "signature": [
              "KbnClientUiSettings"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.importExport",
            "type": "Object",
            "tags": [],
            "label": "importExport",
            "description": [],
            "signature": [
              "KbnClientImportExport"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [
              "\nBasic Kibana server client that implements common behaviors for talking\nto the Kibana server from dev tooling."
            ],
            "signature": [
              "any"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KbnClient.Unnamed.$1",
                "type": "Object",
                "tags": [],
                "label": "options",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/test",
                    "scope": "common",
                    "docId": "kibKbnTestPluginApi",
                    "section": "def-common.KbnClientOptions",
                    "text": "KbnClientOptions"
                  }
                ],
                "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.request",
            "type": "Function",
            "tags": [],
            "label": "request",
            "description": [
              "\nMake a direct request to the Kibana server"
            ],
            "signature": [
              "<T>(options: ",
              "ReqOptions",
              ") => Promise<",
              "AxiosResponse",
              "<T, any>>"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KbnClient.request.$1",
                "type": "Object",
                "tags": [],
                "label": "options",
                "description": [],
                "signature": [
                  "ReqOptions"
                ],
                "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KbnClient.resolveUrl",
            "type": "Function",
            "tags": [],
            "label": "resolveUrl",
            "description": [],
            "signature": [
              "(relativeUrl: string) => string"
            ],
            "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KbnClient.resolveUrl.$1",
                "type": "string",
                "tags": [],
                "label": "relativeUrl",
                "description": [],
                "signature": [
                  "string"
                ],
                "path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.KibanaUrl",
        "type": "Class",
        "tags": [],
        "label": "KibanaUrl",
        "description": [],
        "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KibanaUrl.baseUrl",
            "type": "Object",
            "tags": [],
            "label": "#baseUrl",
            "description": [],
            "signature": [
              "URL"
            ],
            "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KibanaUrl.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KibanaUrl.Unnamed.$1",
                "type": "Object",
                "tags": [],
                "label": "baseUrl",
                "description": [],
                "signature": [
                  "URL"
                ],
                "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KibanaUrl.get",
            "type": "Function",
            "tags": [],
            "label": "get",
            "description": [
              "\nGet an absolute URL based on Kibana's URL"
            ],
            "signature": [
              "(rel?: string | undefined, options?: ",
              "PathOptions",
              " | undefined) => string"
            ],
            "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KibanaUrl.get.$1",
                "type": "string",
                "tags": [],
                "label": "rel",
                "description": [
                  "relative url, resolved relative to Kibana's url"
                ],
                "signature": [
                  "string | undefined"
                ],
                "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": false
              },
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KibanaUrl.get.$2",
                "type": "Object",
                "tags": [],
                "label": "options",
                "description": [
                  "optional modifications to apply to the URL"
                ],
                "signature": [
                  "PathOptions",
                  " | undefined"
                ],
                "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": false
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KibanaUrl.app",
            "type": "Function",
            "tags": [],
            "label": "app",
            "description": [
              "\nGet the URL for an app"
            ],
            "signature": [
              "(appName: string, options?: { space?: string | undefined; pathOptions?: ",
              "PathOptions",
              " | undefined; } | undefined) => string"
            ],
            "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KibanaUrl.app.$1",
                "type": "string",
                "tags": [],
                "label": "appName",
                "description": [
                  "name of the app to get the URL for"
                ],
                "signature": [
                  "string"
                ],
                "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.KibanaUrl.app.$2",
                "type": "Object",
                "tags": [],
                "label": "options",
                "description": [],
                "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
                "deprecated": false,
                "trackAdoption": false,
                "children": [
                  {
                    "parentPluginId": "@kbn/scout",
                    "id": "def-common.KibanaUrl.app.$2.space",
                    "type": "string",
                    "tags": [],
                    "label": "space",
                    "description": [],
                    "signature": [
                      "string | undefined"
                    ],
                    "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
                    "deprecated": false,
                    "trackAdoption": false
                  },
                  {
                    "parentPluginId": "@kbn/scout",
                    "id": "def-common.KibanaUrl.app.$2.pathOptions",
                    "type": "Object",
                    "tags": [],
                    "label": "pathOptions",
                    "description": [],
                    "signature": [
                      "PathOptions",
                      " | undefined"
                    ],
                    "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
                    "deprecated": false,
                    "trackAdoption": false
                  }
                ]
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.KibanaUrl.toString",
            "type": "Function",
            "tags": [],
            "label": "toString",
            "description": [],
            "signature": [
              "() => string"
            ],
            "path": "packages/kbn-scout/src/common/services/kibana_url.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutLogger",
        "type": "Class",
        "tags": [],
        "label": "ScoutLogger",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutLogger",
            "text": "ScoutLogger"
          },
          " extends ",
          {
            "pluginId": "@kbn/tooling-log",
            "scope": "common",
            "docId": "kibKbnToolingLogPluginApi",
            "section": "def-common.ToolingLog",
            "text": "ToolingLog"
          }
        ],
        "path": "packages/kbn-scout/src/common/services/logger.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutLogger.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "packages/kbn-scout/src/common/services/logger.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutLogger.serviceLoaded",
            "type": "Function",
            "tags": [],
            "label": "serviceLoaded",
            "description": [
              "\nUsed to log when a service/fixture is loaded"
            ],
            "signature": [
              "(name: string) => void"
            ],
            "path": "packages/kbn-scout/src/common/services/logger.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/scout",
                "id": "def-common.ScoutLogger.serviceLoaded.$1",
                "type": "string",
                "tags": [],
                "label": "name",
                "description": [
                  "unique name of the service"
                ],
                "signature": [
                  "string"
                ],
                "path": "packages/kbn-scout/src/common/services/logger.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.createLazyPageObject",
        "type": "Function",
        "tags": [],
        "label": "createLazyPageObject",
        "description": [
          "\nCreates a lazily instantiated proxy for a Page Object class, deferring the creation of the instance until\na property or method is accessed. It helps avoiding instantiation of page objects that may not be used\nin certain test scenarios.\n"
        ],
        "signature": [
          "(PageObjectClass: new (page: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutPage",
            "text": "ScoutPage"
          },
          ", ...args: any[]) => T, scoutPage: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutPage",
            "text": "ScoutPage"
          },
          ", constructorArgs: any[]) => T"
        ],
        "path": "packages/kbn-scout/src/playwright/page_objects/utils/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.createLazyPageObject.$1",
            "type": "Object",
            "tags": [],
            "label": "PageObjectClass",
            "description": [
              "- The page object class to be instantiated lazily."
            ],
            "signature": [
              "new (page: ",
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.ScoutPage",
                "text": "ScoutPage"
              },
              ", ...args: any[]) => T"
            ],
            "path": "packages/kbn-scout/src/playwright/page_objects/utils/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.createLazyPageObject.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "scoutPage",
            "description": [
              "- ScoutPage instance, that extendes the Playwright `page` fixture and passed to the page object class constructor."
            ],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.ScoutPage",
                "text": "ScoutPage"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/page_objects/utils/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.createLazyPageObject.$3",
            "type": "Array",
            "tags": [],
            "label": "constructorArgs",
            "description": [
              "- Additional arguments to be passed to the page object class constructor."
            ],
            "signature": [
              "any[]"
            ],
            "path": "packages/kbn-scout/src/playwright/page_objects/utils/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [
          "A proxy object that behaves like an instance of the page object class, instantiating it on demand."
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.createPlaywrightConfig",
        "type": "Function",
        "tags": [],
        "label": "createPlaywrightConfig",
        "description": [],
        "signature": [
          "(options: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutPlaywrightOptions",
            "text": "ScoutPlaywrightOptions"
          },
          ") => ",
          "PlaywrightTestConfig",
          "<{}, {}>"
        ],
        "path": "packages/kbn-scout/src/playwright/config/create_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.createPlaywrightConfig.$1",
            "type": "Object",
            "tags": [],
            "label": "options",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.ScoutPlaywrightOptions",
                "text": "ScoutPlaywrightOptions"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/config/create_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.expect",
        "type": "Function",
        "tags": [],
        "label": "expect",
        "description": [],
        "signature": [
          "{ <T = unknown>(actual: T, messageOrOptions?: string | { message?: string | undefined; } | undefined): MakeMatchers<void, T, {}>; soft: <T = unknown>(actual: T, messageOrOptions?: string | { message?: string | undefined; } | undefined) => MakeMatchers<void, T, {}>; poll: <T = unknown>(actual: () => T | Promise<T>, messageOrOptions?: string | { message?: string | undefined; timeout?: number | undefined; intervals?: number[] | undefined; } | undefined) => PollMatchers<Promise<void>, T, {}>; extend<MoreMatchers extends Record<string, (this: ",
          "ExpectMatcherState",
          ", receiver: any, ...args: any[]) => ",
          "MatcherReturnType",
          " | Promise<",
          "MatcherReturnType",
          ">>>(matchers: MoreMatchers): ",
          "Expect",
          "<{} & MoreMatchers>; configure: (configuration: { message?: string | undefined; timeout?: number | undefined; soft?: boolean | undefined; }) => ",
          "Expect",
          "<{}>; getState(): unknown; not: Omit<AsymmetricMatchers, \"any\" | \"anything\">; } & AsymmetricMatchers"
        ],
        "path": "packages/kbn-scout/src/playwright/expect.ts",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.expect.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "actual",
            "description": [],
            "signature": [
              "T"
            ],
            "path": "node_modules/playwright/types/test.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.expect.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "messageOrOptions",
            "description": [],
            "signature": [
              "string | { message?: string | undefined; } | undefined"
            ],
            "path": "node_modules/playwright/types/test.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ingestTestDataHook",
        "type": "Function",
        "tags": [],
        "label": "ingestTestDataHook",
        "description": [],
        "signature": [
          "(config: ",
          "FullConfig",
          "<{}, {}>, archives: string[]) => Promise<void>"
        ],
        "path": "packages/kbn-scout/src/playwright/global_hooks/data_ingestion.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ingestTestDataHook.$1",
            "type": "Object",
            "tags": [],
            "label": "config",
            "description": [],
            "signature": [
              "FullConfig",
              "<{}, {}>"
            ],
            "path": "packages/kbn-scout/src/playwright/global_hooks/data_ingestion.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ingestTestDataHook.$2",
            "type": "Array",
            "tags": [],
            "label": "archives",
            "description": [],
            "signature": [
              "string[]"
            ],
            "path": "packages/kbn-scout/src/playwright/global_hooks/data_ingestion.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.spaceTest",
        "type": "Function",
        "tags": [],
        "label": "spaceTest",
        "description": [],
        "signature": [
          "TestType",
          "<",
          "PlaywrightTestArgs",
          " & ",
          "PlaywrightTestOptions",
          " & { browserAuth: ",
          "BrowserAuthFixture",
          "; } & { page: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutPage",
            "text": "ScoutPage"
          },
          "; } & { pageObjects: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.PageObjects",
            "text": "PageObjects"
          },
          "; } & { validateTags: void; }, ",
          "PlaywrightWorkerArgs",
          " & ",
          "PlaywrightWorkerOptions",
          " & { log: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutLogger",
            "text": "ScoutLogger"
          },
          "; config: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutTestConfig",
            "text": "ScoutTestConfig"
          },
          "; kbnUrl: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.KibanaUrl",
            "text": "KibanaUrl"
          },
          "; esClient: ",
          "default",
          "; kbnClient: ",
          {
            "pluginId": "@kbn/test",
            "scope": "common",
            "docId": "kibKbnTestPluginApi",
            "section": "def-common.KbnClient",
            "text": "KbnClient"
          },
          "; samlAuth: ",
          {
            "pluginId": "@kbn/test",
            "scope": "common",
            "docId": "kibKbnTestPluginApi",
            "section": "def-common.SamlSessionManager",
            "text": "SamlSessionManager"
          },
          "; } & { scoutSpace: ",
          "ScoutSpaceParallelFixture",
          "; } & { scoutSpace: ",
          "ScoutSpaceParallelFixture",
          "; } & { log: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutLogger",
            "text": "ScoutLogger"
          },
          "; kbnUrl: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.KibanaUrl",
            "text": "KibanaUrl"
          },
          "; scoutSpace: ",
          "ScoutSpaceParallelFixture",
          "; } & { scoutSpace: ",
          "ScoutSpaceParallelFixture",
          "; }>"
        ],
        "path": "packages/kbn-scout/src/playwright/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.test",
        "type": "Function",
        "tags": [],
        "label": "test",
        "description": [],
        "signature": [
          "TestType",
          "<",
          "PlaywrightTestArgs",
          " & ",
          "PlaywrightTestOptions",
          " & { browserAuth: ",
          "BrowserAuthFixture",
          "; } & { page: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutPage",
            "text": "ScoutPage"
          },
          "; log: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutLogger",
            "text": "ScoutLogger"
          },
          "; } & { pageObjects: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.PageObjects",
            "text": "PageObjects"
          },
          "; } & { validateTags: void; }, ",
          "PlaywrightWorkerArgs",
          " & ",
          "PlaywrightWorkerOptions",
          " & { log: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutLogger",
            "text": "ScoutLogger"
          },
          "; config: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutTestConfig",
            "text": "ScoutTestConfig"
          },
          "; kbnUrl: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.KibanaUrl",
            "text": "KibanaUrl"
          },
          "; esClient: ",
          "default",
          "; kbnClient: ",
          {
            "pluginId": "@kbn/test",
            "scope": "common",
            "docId": "kibKbnTestPluginApi",
            "section": "def-common.KbnClient",
            "text": "KbnClient"
          },
          "; samlAuth: ",
          {
            "pluginId": "@kbn/test",
            "scope": "common",
            "docId": "kibKbnTestPluginApi",
            "section": "def-common.SamlSessionManager",
            "text": "SamlSessionManager"
          },
          "; } & { esArchiver: ",
          "EsArchiverFixture",
          "; } & { uiSettings: ",
          "UiSettingsFixture",
          "; } & { kbnUrl: ",
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.KibanaUrl",
            "text": "KibanaUrl"
          },
          "; }>"
        ],
        "path": "packages/kbn-scout/src/playwright/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.PageObjects",
        "type": "Interface",
        "tags": [],
        "label": "PageObjects",
        "description": [],
        "path": "packages/kbn-scout/src/playwright/page_objects/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.PageObjects.datePicker",
            "type": "Object",
            "tags": [],
            "label": "datePicker",
            "description": [],
            "signature": [
              "DatePicker"
            ],
            "path": "packages/kbn-scout/src/playwright/page_objects/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.PageObjects.discover",
            "type": "Object",
            "tags": [],
            "label": "discover",
            "description": [],
            "signature": [
              "DiscoverApp"
            ],
            "path": "packages/kbn-scout/src/playwright/page_objects/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.PageObjects.dashboard",
            "type": "Object",
            "tags": [],
            "label": "dashboard",
            "description": [],
            "signature": [
              "DashboardApp"
            ],
            "path": "packages/kbn-scout/src/playwright/page_objects/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.PageObjects.filterBar",
            "type": "Object",
            "tags": [],
            "label": "filterBar",
            "description": [],
            "signature": [
              "FilterBar"
            ],
            "path": "packages/kbn-scout/src/playwright/page_objects/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutParallelTestFixtures",
        "type": "Interface",
        "tags": [],
        "label": "ScoutParallelTestFixtures",
        "description": [],
        "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelTestFixtures.browserAuth",
            "type": "Object",
            "tags": [],
            "label": "browserAuth",
            "description": [],
            "signature": [
              "BrowserAuthFixture"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelTestFixtures.page",
            "type": "CompoundType",
            "tags": [],
            "label": "page",
            "description": [],
            "signature": [
              "Page",
              " & { gotoApp: (appName: string, options?: { referer?: string | undefined; timeout?: number | undefined; waitUntil?: \"load\" | \"domcontentloaded\" | \"networkidle\" | \"commit\" | undefined; } | undefined) => Promise<",
              "Response",
              " | null>; waitForLoadingIndicatorHidden: () => Promise<",
              "ElementHandle",
              "<HTMLElement | SVGElement> | null>; testSubj: { check: (selector: string, options?: { force?: boolean | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; click: (selector: string, options?: { button?: \"right\" | \"left\" | \"middle\" | undefined; clickCount?: number | undefined; delay?: number | undefined; force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; dblclick: (selector: string, options?: { button?: \"right\" | \"left\" | \"middle\" | undefined; delay?: number | undefined; force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; fill: (selector: string, value: string, options?: { force?: boolean | undefined; noWaitAfter?: boolean | undefined; strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<void>; focus: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<void>; getAttribute: (selector: string, name: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<string | null>; hover: (selector: string, options?: { force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; innerText: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<string>; isEnabled: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isChecked: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isHidden: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isVisible: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; locator: (selector: string, options?: { has?: ",
              "Locator",
              " | undefined; hasNot?: ",
              "Locator",
              " | undefined; hasNotText?: string | RegExp | undefined; hasText?: string | RegExp | undefined; } | undefined) => ",
              "Locator",
              "; waitForSelector: (selector: string, options?: PageWaitForSelectorOptions | undefined) => Promise<",
              "ElementHandle",
              "<HTMLElement | SVGElement> | null>; typeWithDelay: (selector: string, text: string, options?: { delay: number; } | undefined) => Promise<void>; clearInput: (selector: string) => Promise<void>; }; }"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelTestFixtures.pageObjects",
            "type": "Object",
            "tags": [],
            "label": "pageObjects",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.PageObjects",
                "text": "PageObjects"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutParallelWorkerFixtures",
        "type": "Interface",
        "tags": [],
        "label": "ScoutParallelWorkerFixtures",
        "description": [],
        "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelWorkerFixtures.log",
            "type": "Object",
            "tags": [],
            "label": "log",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.ScoutLogger",
                "text": "ScoutLogger"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelWorkerFixtures.config",
            "type": "Object",
            "tags": [],
            "label": "config",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.ScoutTestConfig",
                "text": "ScoutTestConfig"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelWorkerFixtures.kbnUrl",
            "type": "Object",
            "tags": [],
            "label": "kbnUrl",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.KibanaUrl",
                "text": "KibanaUrl"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelWorkerFixtures.kbnClient",
            "type": "Object",
            "tags": [],
            "label": "kbnClient",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/test",
                "scope": "common",
                "docId": "kibKbnTestPluginApi",
                "section": "def-common.KbnClient",
                "text": "KbnClient"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelWorkerFixtures.esClient",
            "type": "Object",
            "tags": [],
            "label": "esClient",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutParallelWorkerFixtures.scoutSpace",
            "type": "Object",
            "tags": [],
            "label": "scoutSpace",
            "description": [],
            "signature": [
              "ScoutSpaceParallelFixture"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutPlaywrightOptions",
        "type": "Interface",
        "tags": [],
        "label": "ScoutPlaywrightOptions",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutPlaywrightOptions",
            "text": "ScoutPlaywrightOptions"
          },
          " extends Pick<",
          "PlaywrightTestConfig",
          "<{}, {}>, \"workers\" | \"testDir\" | \"globalSetup\">"
        ],
        "path": "packages/kbn-scout/src/playwright/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutPlaywrightOptions.testDir",
            "type": "string",
            "tags": [],
            "label": "testDir",
            "description": [],
            "path": "packages/kbn-scout/src/playwright/types/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutPlaywrightOptions.workers",
            "type": "CompoundType",
            "tags": [],
            "label": "workers",
            "description": [],
            "signature": [
              "2 | 1 | 3 | undefined"
            ],
            "path": "packages/kbn-scout/src/playwright/types/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutPlaywrightOptions.globalSetup",
            "type": "string",
            "tags": [],
            "label": "globalSetup",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/kbn-scout/src/playwright/types/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutServerConfig",
        "type": "Interface",
        "tags": [],
        "label": "ScoutServerConfig",
        "description": [],
        "path": "packages/kbn-scout/src/types/server_config.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutServerConfig.serverless",
            "type": "CompoundType",
            "tags": [],
            "label": "serverless",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "packages/kbn-scout/src/types/server_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutServerConfig.servers",
            "type": "Object",
            "tags": [],
            "label": "servers",
            "description": [],
            "signature": [
              "{ kibana: ",
              {
                "pluginId": "@kbn/test",
                "scope": "common",
                "docId": "kibKbnTestPluginApi",
                "section": "def-common.UrlParts",
                "text": "UrlParts"
              },
              "; elasticsearch: ",
              {
                "pluginId": "@kbn/test",
                "scope": "common",
                "docId": "kibKbnTestPluginApi",
                "section": "def-common.UrlParts",
                "text": "UrlParts"
              },
              "; fleet?: ",
              {
                "pluginId": "@kbn/test",
                "scope": "common",
                "docId": "kibKbnTestPluginApi",
                "section": "def-common.UrlParts",
                "text": "UrlParts"
              },
              " | undefined; }"
            ],
            "path": "packages/kbn-scout/src/types/server_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutServerConfig.dockerServers",
            "type": "Any",
            "tags": [],
            "label": "dockerServers",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "packages/kbn-scout/src/types/server_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutServerConfig.esTestCluster",
            "type": "Object",
            "tags": [],
            "label": "esTestCluster",
            "description": [],
            "signature": [
              "{ from: string; license?: string | undefined; files: string[]; serverArgs: string[]; ssl: boolean; }"
            ],
            "path": "packages/kbn-scout/src/types/server_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutServerConfig.kbnTestServer",
            "type": "Object",
            "tags": [],
            "label": "kbnTestServer",
            "description": [],
            "signature": [
              "{ env: any; buildArgs: string[]; sourceArgs: string[]; serverArgs: string[]; useDedicatedTestRunner?: boolean | undefined; }"
            ],
            "path": "packages/kbn-scout/src/types/server_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutTestConfig",
        "type": "Interface",
        "tags": [],
        "label": "ScoutTestConfig",
        "description": [],
        "path": "packages/kbn-scout/src/types/test_config.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.serverless",
            "type": "boolean",
            "tags": [],
            "label": "serverless",
            "description": [],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.projectType",
            "type": "CompoundType",
            "tags": [],
            "label": "projectType",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/es",
                "scope": "common",
                "docId": "kibKbnEsPluginApi",
                "section": "def-common.ServerlessProjectType",
                "text": "ServerlessProjectType"
              },
              " | undefined"
            ],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.isCloud",
            "type": "boolean",
            "tags": [],
            "label": "isCloud",
            "description": [],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.license",
            "type": "string",
            "tags": [],
            "label": "license",
            "description": [],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.cloudUsersFilePath",
            "type": "string",
            "tags": [],
            "label": "cloudUsersFilePath",
            "description": [],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.hosts",
            "type": "Object",
            "tags": [],
            "label": "hosts",
            "description": [],
            "signature": [
              "{ kibana: string; elasticsearch: string; }"
            ],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.auth",
            "type": "Object",
            "tags": [],
            "label": "auth",
            "description": [],
            "signature": [
              "{ username: string; password: string; }"
            ],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestConfig.metadata",
            "type": "Any",
            "tags": [],
            "label": "metadata",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "packages/kbn-scout/src/types/test_config.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutTestFixtures",
        "type": "Interface",
        "tags": [],
        "label": "ScoutTestFixtures",
        "description": [],
        "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestFixtures.browserAuth",
            "type": "Object",
            "tags": [],
            "label": "browserAuth",
            "description": [],
            "signature": [
              "BrowserAuthFixture"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestFixtures.page",
            "type": "CompoundType",
            "tags": [],
            "label": "page",
            "description": [],
            "signature": [
              "Page",
              " & { gotoApp: (appName: string, options?: { referer?: string | undefined; timeout?: number | undefined; waitUntil?: \"load\" | \"domcontentloaded\" | \"networkidle\" | \"commit\" | undefined; } | undefined) => Promise<",
              "Response",
              " | null>; waitForLoadingIndicatorHidden: () => Promise<",
              "ElementHandle",
              "<HTMLElement | SVGElement> | null>; testSubj: { check: (selector: string, options?: { force?: boolean | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; click: (selector: string, options?: { button?: \"right\" | \"left\" | \"middle\" | undefined; clickCount?: number | undefined; delay?: number | undefined; force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; dblclick: (selector: string, options?: { button?: \"right\" | \"left\" | \"middle\" | undefined; delay?: number | undefined; force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; fill: (selector: string, value: string, options?: { force?: boolean | undefined; noWaitAfter?: boolean | undefined; strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<void>; focus: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<void>; getAttribute: (selector: string, name: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<string | null>; hover: (selector: string, options?: { force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; innerText: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<string>; isEnabled: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isChecked: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isHidden: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isVisible: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; locator: (selector: string, options?: { has?: ",
              "Locator",
              " | undefined; hasNot?: ",
              "Locator",
              " | undefined; hasNotText?: string | RegExp | undefined; hasText?: string | RegExp | undefined; } | undefined) => ",
              "Locator",
              "; waitForSelector: (selector: string, options?: PageWaitForSelectorOptions | undefined) => Promise<",
              "ElementHandle",
              "<HTMLElement | SVGElement> | null>; typeWithDelay: (selector: string, text: string, options?: { delay: number; } | undefined) => Promise<void>; clearInput: (selector: string) => Promise<void>; }; }"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestFixtures.pageObjects",
            "type": "Object",
            "tags": [],
            "label": "pageObjects",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.PageObjects",
                "text": "PageObjects"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutTestOptions",
        "type": "Interface",
        "tags": [],
        "label": "ScoutTestOptions",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/scout",
            "scope": "common",
            "docId": "kibKbnScoutPluginApi",
            "section": "def-common.ScoutTestOptions",
            "text": "ScoutTestOptions"
          },
          " extends ",
          "PlaywrightTestOptions"
        ],
        "path": "packages/kbn-scout/src/playwright/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestOptions.serversConfigDir",
            "type": "string",
            "tags": [],
            "label": "serversConfigDir",
            "description": [],
            "path": "packages/kbn-scout/src/playwright/types/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutTestOptions.VALID_CONFIG_MARKER",
            "type": "boolean",
            "tags": [],
            "label": "[VALID_CONFIG_MARKER]",
            "description": [],
            "path": "packages/kbn-scout/src/playwright/types/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutWorkerFixtures",
        "type": "Interface",
        "tags": [],
        "label": "ScoutWorkerFixtures",
        "description": [],
        "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutWorkerFixtures.log",
            "type": "Object",
            "tags": [],
            "label": "log",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.ScoutLogger",
                "text": "ScoutLogger"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutWorkerFixtures.config",
            "type": "Object",
            "tags": [],
            "label": "config",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.ScoutTestConfig",
                "text": "ScoutTestConfig"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutWorkerFixtures.kbnUrl",
            "type": "Object",
            "tags": [],
            "label": "kbnUrl",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/scout",
                "scope": "common",
                "docId": "kibKbnScoutPluginApi",
                "section": "def-common.KibanaUrl",
                "text": "KibanaUrl"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutWorkerFixtures.kbnClient",
            "type": "Object",
            "tags": [],
            "label": "kbnClient",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/test",
                "scope": "common",
                "docId": "kibKbnTestPluginApi",
                "section": "def-common.KbnClient",
                "text": "KbnClient"
              }
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutWorkerFixtures.esClient",
            "type": "Object",
            "tags": [],
            "label": "esClient",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutWorkerFixtures.esArchiver",
            "type": "Object",
            "tags": [],
            "label": "esArchiver",
            "description": [],
            "signature": [
              "EsArchiverFixture"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.ScoutWorkerFixtures.uiSettings",
            "type": "Object",
            "tags": [],
            "label": "uiSettings",
            "description": [],
            "signature": [
              "UiSettingsFixture"
            ],
            "path": "packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.ScoutPage",
        "type": "Type",
        "tags": [],
        "label": "ScoutPage",
        "description": [
          "\nExtends the Playwright 'Page' interface with methods specific to Kibana.\nReasons to use 'ReturnType' instead of Explicit Typings:\n- DRY Principle: automatically stays in sync with the Playwright API, reducing maintenance overhead.\n- Future-Proofing: If Playwright changes the return type of methods, these types will update accordingly.\nRecommendation: define Explicit Types as return types only if methods (e.g. 'typeWithDelay')\nhave any additional logic or Kibana-specific behavior."
        ],
        "signature": [
          "Page",
          " & { gotoApp: (appName: string, options?: { referer?: string | undefined; timeout?: number | undefined; waitUntil?: \"load\" | \"domcontentloaded\" | \"networkidle\" | \"commit\" | undefined; } | undefined) => Promise<",
          "Response",
          " | null>; waitForLoadingIndicatorHidden: () => Promise<",
          "ElementHandle",
          "<HTMLElement | SVGElement> | null>; testSubj: { check: (selector: string, options?: { force?: boolean | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; click: (selector: string, options?: { button?: \"right\" | \"left\" | \"middle\" | undefined; clickCount?: number | undefined; delay?: number | undefined; force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; dblclick: (selector: string, options?: { button?: \"right\" | \"left\" | \"middle\" | undefined; delay?: number | undefined; force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; fill: (selector: string, value: string, options?: { force?: boolean | undefined; noWaitAfter?: boolean | undefined; strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<void>; focus: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<void>; getAttribute: (selector: string, name: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<string | null>; hover: (selector: string, options?: { force?: boolean | undefined; modifiers?: (\"Alt\" | \"Control\" | \"Meta\" | \"Shift\" | \"ControlOrMeta\")[] | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; strict?: boolean | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise<void>; innerText: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<string>; isEnabled: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isChecked: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isHidden: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; isVisible: (selector: string, options?: { strict?: boolean | undefined; timeout?: number | undefined; } | undefined) => Promise<boolean>; locator: (selector: string, options?: { has?: ",
          "Locator",
          " | undefined; hasNot?: ",
          "Locator",
          " | undefined; hasNotText?: string | RegExp | undefined; hasText?: string | RegExp | undefined; } | undefined) => ",
          "Locator",
          "; waitForSelector: (selector: string, options?: PageWaitForSelectorOptions | undefined) => Promise<",
          "ElementHandle",
          "<HTMLElement | SVGElement> | null>; typeWithDelay: (selector: string, text: string, options?: { delay: number; } | undefined) => Promise<void>; clearInput: (selector: string) => Promise<void>; }; }"
        ],
        "path": "packages/kbn-scout/src/playwright/fixtures/test/scout_page/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/scout",
        "id": "def-common.tags",
        "type": "Object",
        "tags": [],
        "label": "tags",
        "description": [],
        "path": "packages/kbn-scout/src/playwright/tags.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.tags.ESS_ONLY",
            "type": "Array",
            "tags": [],
            "label": "ESS_ONLY",
            "description": [],
            "signature": [
              "string[]"
            ],
            "path": "packages/kbn-scout/src/playwright/tags.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.tags.SERVERLESS_ONLY",
            "type": "Array",
            "tags": [],
            "label": "SERVERLESS_ONLY",
            "description": [],
            "signature": [
              "string[]"
            ],
            "path": "packages/kbn-scout/src/playwright/tags.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/scout",
            "id": "def-common.tags.DEPLOYMENT_AGNOSTIC",
            "type": "Array",
            "tags": [],
            "label": "DEPLOYMENT_AGNOSTIC",
            "description": [],
            "signature": [
              "string[]"
            ],
            "path": "packages/kbn-scout/src/playwright/tags.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}