{ "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" ], "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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": [ "(options: ", "ReqOptions", ") => Promise<", "AxiosResponse", ">" ], "path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/kbn-scout/src/common/services/kibana_url.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.KibanaUrl.domain", "type": "Function", "tags": [], "label": "domain", "description": [], "signature": [ "() => string" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/kibana_url.ts", "deprecated": false, "trackAdoption": false, "children": [], "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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/kbn-scout/src/common/services/logger.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.ScoutLogger.Unnamed.$1", "type": "string", "tags": [], "label": "workerContext", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/logger.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "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": "src/platform/packages/shared/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": "src/platform/packages/shared/kbn-scout/src/common/services/logger.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.ScoutLogger.serviceMessage", "type": "Function", "tags": [], "label": "serviceMessage", "description": [ "\nUsed to log a message for a service/fixture" ], "signature": [ "(name: string, message: string) => void" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/logger.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.ScoutLogger.serviceMessage.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/logger.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.ScoutLogger.serviceMessage.$2", "type": "string", "tags": [], "label": "message", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/logger.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "@kbn/scout", "id": "def-common.browserAuthFixture", "type": "Function", "tags": [], "label": "browserAuthFixture", "description": [ "\nThe \"browserAuth\" fixture simplifies the process of logging into Kibana with\ndifferent roles during tests. It uses the \"samlAuth\" fixture to create an authentication session\nfor the specified role and the \"context\" fixture to update the cookie with the role-scoped session." ], "signature": [ "TestType", "<", "PlaywrightTestArgs", " & ", "PlaywrightTestOptions", " & { browserAuth: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.BrowserAuthFixture", "text": "BrowserAuthFixture" }, "; }, ", "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/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.SamlAuth", "text": "SamlAuth" }, "; }>" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "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: Args) => T, scoutPage: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ScoutPage", "text": "ScoutPage" }, ", constructorArgs: Args) => T" ], "path": "src/platform/packages/shared/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: Args) => T" ], "path": "src/platform/packages/shared/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 extends 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": "src/platform/packages/shared/kbn-scout/src/playwright/page_objects/utils/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.createLazyPageObject.$3", "type": "Uncategorized", "tags": [], "label": "constructorArgs", "description": [ "- Additional arguments to be passed to the page object class constructor." ], "signature": [ "Args" ], "path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": [ "{ (actual: T, messageOrOptions?: string | { message?: string | undefined; } | undefined): MakeMatchers; soft: (actual: T, messageOrOptions?: string | { message?: string | undefined; } | undefined) => MakeMatchers; poll: (actual: () => T | Promise, messageOrOptions?: string | { message?: string | undefined; timeout?: number | undefined; intervals?: number[] | undefined; } | undefined) => PollMatchers, T, {}>; extend ", "MatcherReturnType", " | Promise<", "MatcherReturnType", ">>>(matchers: MoreMatchers): ", "Expect", "<{} & MoreMatchers>; configure: (configuration: { message?: string | undefined; timeout?: number | undefined; soft?: boolean | undefined; }) => ", "Expect", "<{}>; getState(): unknown; not: Omit; } & AsymmetricMatchers" ], "path": "src/platform/packages/shared/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.globalSetupHook", "type": "Function", "tags": [], "label": "globalSetupHook", "description": [], "signature": [ "TestType", "<", "PlaywrightTestArgs", " & ", "PlaywrightTestOptions", ", ", "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/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.SamlAuth", "text": "SamlAuth" }, "; } & { esArchiver: ", "EsArchiverFixture", "; } & ", "SynthtraceFixture", " & { apiServices: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ApiServicesFixture", "text": "ApiServicesFixture" }, "; }>" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.lighthouseTest", "type": "Function", "tags": [], "label": "lighthouseTest", "description": [], "signature": [ "TestType", "<", "PlaywrightTestArgs", " & ", "PlaywrightTestOptions", " & { browserAuth: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.BrowserAuthFixture", "text": "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; } & { perfTracker: ", "PerformanceTracker", "; } & { context: ", "BrowserContext", "; } & { lighthouse: ", "LighthouseFixture", "; }, ", "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/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.SamlAuth", "text": "SamlAuth" }, "; } & { esArchiver: ", "EsArchiverFixture", "; } & { uiSettings: ", "UiSettingsFixture", "; } & ", "SynthtraceFixture", " & { apiServices: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ApiServicesFixture", "text": "ApiServicesFixture" }, "; } & { kbnUrl: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.KibanaUrl", "text": "KibanaUrl" }, "; } & { config: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ScoutTestConfig", "text": "ScoutTestConfig" }, "; } & { debuggingPort: number; } & { debuggingPort: number; }>" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformance", "type": "Function", "tags": [], "label": "measurePerformance", "description": [ "\nMeasure the performance of a sync function" ], "signature": [ "(log: ", { "pluginId": "@kbn/tooling-log", "scope": "common", "docId": "kibKbnToolingLogPluginApi", "section": "def-common.ToolingLog", "text": "ToolingLog" }, ", label: string, fn: () => T) => T" ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformance.$1", "type": "Object", "tags": [], "label": "log", "description": [], "signature": [ { "pluginId": "@kbn/tooling-log", "scope": "common", "docId": "kibKbnToolingLogPluginApi", "section": "def-common.ToolingLog", "text": "ToolingLog" } ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformance.$2", "type": "string", "tags": [], "label": "label", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformance.$3", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "() => T" ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformanceAsync", "type": "Function", "tags": [], "label": "measurePerformanceAsync", "description": [ "\nMeasure the performance of an async function" ], "signature": [ "(log: ", { "pluginId": "@kbn/tooling-log", "scope": "common", "docId": "kibKbnToolingLogPluginApi", "section": "def-common.ToolingLog", "text": "ToolingLog" }, ", label: string, fn: () => Promise) => Promise" ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformanceAsync.$1", "type": "Object", "tags": [], "label": "log", "description": [], "signature": [ { "pluginId": "@kbn/tooling-log", "scope": "common", "docId": "kibKbnToolingLogPluginApi", "section": "def-common.ToolingLog", "text": "ToolingLog" } ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformanceAsync.$2", "type": "string", "tags": [], "label": "label", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.measurePerformanceAsync.$3", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "() => Promise" ], "path": "src/platform/packages/shared/kbn-scout/src/common/utils/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.mergeTests", "type": "Function", "tags": [], "label": "mergeTests", "description": [ "\nMerges fixtures" ], "signature": [ "(tests: List) => MergedTestType" ], "path": "node_modules/playwright/types/test.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.mergeTests.$1", "type": "Uncategorized", "tags": [], "label": "tests", "description": [], "signature": [ "List" ], "path": "node_modules/playwright/types/test.d.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: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.BrowserAuthFixture", "text": "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/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.SamlAuth", "text": "SamlAuth" }, "; } & { scoutSpace: ", "ScoutSpaceParallelFixture", "; } & { apiServices: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ApiServicesFixture", "text": "ApiServicesFixture" }, "; } & { 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", "; config: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ScoutTestConfig", "text": "ScoutTestConfig" }, "; }>" ], "path": "src/platform/packages/shared/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: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.BrowserAuthFixture", "text": "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; } & { perfTracker: ", "PerformanceTracker", "; }, ", "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/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.SamlAuth", "text": "SamlAuth" }, "; } & { esArchiver: ", "EsArchiverFixture", "; } & { uiSettings: ", "UiSettingsFixture", "; } & ", "SynthtraceFixture", " & { apiServices: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ApiServicesFixture", "text": "ApiServicesFixture" }, "; } & { kbnUrl: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.KibanaUrl", "text": "KibanaUrl" }, "; } & { config: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.ScoutTestConfig", "text": "ScoutTestConfig" }, "; }>" ], "path": "src/platform/packages/shared/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": [ "\nThese tests are executed in Playwright environment that launches the browser\nand provides a fresh page to each test." ], "signature": [ "TestType", "<", "PlaywrightTestArgs", " & ", "PlaywrightTestOptions", ", ", "PlaywrightWorkerArgs", " & ", "PlaywrightWorkerOptions", ">" ], "path": "node_modules/playwright/types/test.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/scout", "id": "def-common.ApiServicesFixture", "type": "Interface", "tags": [], "label": "ApiServicesFixture", "description": [], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/worker/apis/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.ApiServicesFixture.fleet", "type": "Object", "tags": [], "label": "fleet", "description": [], "signature": [ "FleetApiService" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/worker/apis/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture", "type": "Interface", "tags": [], "label": "BrowserAuthFixture", "description": [], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture.loginAsViewer", "type": "Function", "tags": [], "label": "loginAsViewer", "description": [ "\nLogs in as a user with viewer-only permissions." ], "signature": [ "() => Promise" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "A Promise that resolves once the cookie in browser is set." ] }, { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture.loginAsAdmin", "type": "Function", "tags": [], "label": "loginAsAdmin", "description": [ "\nLogs in as a user with administrative privileges" ], "signature": [ "() => Promise" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "A Promise that resolves once the cookie in browser is set." ] }, { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture.loginAsPrivilegedUser", "type": "Function", "tags": [], "label": "loginAsPrivilegedUser", "description": [ "\nLogs in as a user with elevated, but not admin, permissions." ], "signature": [ "() => Promise" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "A Promise that resolves once the cookie in browser is set." ] }, { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture.loginAs", "type": "Function", "tags": [], "label": "loginAs", "description": [ "\nLogs in as a user with a role." ], "signature": [ "(role: string) => Promise" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture.loginAs.$1", "type": "string", "tags": [], "label": "role", "description": [ "- A role object that defines the Kibana and ES previleges." ], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "A Promise that resolves once the cookie in browser is set." ] }, { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture.loginWithCustomRole", "type": "Function", "tags": [], "label": "loginWithCustomRole", "description": [ "\nLogs in as a user with a custom role." ], "signature": [ "(role: ", { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.KibanaRole", "text": "KibanaRole" }, ") => Promise" ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.BrowserAuthFixture.loginWithCustomRole.$1", "type": "Object", "tags": [], "label": "role", "description": [ "- A role object that defines the Kibana and ES previleges. Role will re-created if it doesn't exist." ], "signature": [ { "pluginId": "@kbn/scout", "scope": "common", "docId": "kibKbnScoutPluginApi", "section": "def-common.KibanaRole", "text": "KibanaRole" } ], "path": "src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "A Promise that resolves once the cookie in browser is set." ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession", "type": "Interface", "tags": [], "label": "CDPSession", "description": [ "\nThe `CDPSession` instances are used to talk raw Chrome Devtools Protocol:\n- protocol methods can be called with `session.send` method.\n- protocol events can be subscribed to with `session.on` method.\n\nUseful links:\n- Documentation on DevTools Protocol can be found here:\n [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).\n- Getting Started with DevTools Protocol:\n https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md\n\n```js\nconst client = await page.context().newCDPSession(page);\nawait client.send('Animation.enable');\nclient.on('Animation.animationCreated', () => console.log('Animation created!'));\nconst response = await client.send('Animation.getPlaybackRate');\nconsole.log('playback rate is ' + response.playbackRate);\nawait client.send('Animation.setPlaybackRate', {\n playbackRate: response.playbackRate / 2\n});\n```\n" ], "signature": [ "CDPSession" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.on", "type": "Function", "tags": [], "label": "on", "description": [], "signature": [ "(event: T, listener: (payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void) => this" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.on.$1", "type": "Uncategorized", "tags": [], "label": "event", "description": [], "signature": [ "T" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.on.$2", "type": "Function", "tags": [], "label": "listener", "description": [], "signature": [ "(payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.addListener", "type": "Function", "tags": [], "label": "addListener", "description": [], "signature": [ "(event: T, listener: (payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void) => this" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.addListener.$1", "type": "Uncategorized", "tags": [], "label": "event", "description": [], "signature": [ "T" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.addListener.$2", "type": "Function", "tags": [], "label": "listener", "description": [], "signature": [ "(payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.off", "type": "Function", "tags": [], "label": "off", "description": [], "signature": [ "(event: T, listener: (payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void) => this" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.off.$1", "type": "Uncategorized", "tags": [], "label": "event", "description": [], "signature": [ "T" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.off.$2", "type": "Function", "tags": [], "label": "listener", "description": [], "signature": [ "(payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.removeListener", "type": "Function", "tags": [], "label": "removeListener", "description": [], "signature": [ "(event: T, listener: (payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void) => this" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.removeListener.$1", "type": "Uncategorized", "tags": [], "label": "event", "description": [], "signature": [ "T" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.removeListener.$2", "type": "Function", "tags": [], "label": "listener", "description": [], "signature": [ "(payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.once", "type": "Function", "tags": [], "label": "once", "description": [], "signature": [ "(event: T, listener: (payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void) => this" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.once.$1", "type": "Uncategorized", "tags": [], "label": "event", "description": [], "signature": [ "T" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.once.$2", "type": "Function", "tags": [], "label": "listener", "description": [], "signature": [ "(payload: T extends symbol ? any : ", "Protocol", ".Events[T extends keyof ", "Protocol", ".Events ? T : never]) => void" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.send", "type": "Function", "tags": [], "label": "send", "description": [], "signature": [ "(method: T, params?: ", "Protocol", ".CommandParameters[T] | undefined) => Promise<", "Protocol", ".CommandReturnValues[T]>" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.send.$1", "type": "Uncategorized", "tags": [], "label": "method", "description": [ "Protocol method name." ], "signature": [ "T" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.send.$2", "type": "Uncategorized", "tags": [], "label": "params", "description": [ "Optional method parameters." ], "signature": [ "Protocol", ".CommandParameters[T] | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.CDPSession.detach", "type": "Function", "tags": [], "label": "detach", "description": [ "\nDetaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be\nused to send messages." ], "signature": [ "() => Promise" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.ElasticsearchRoleDescriptor", "type": "Interface", "tags": [], "label": "ElasticsearchRoleDescriptor", "description": [], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.ElasticsearchRoleDescriptor.cluster", "type": "Array", "tags": [], "label": "cluster", "description": [], "signature": [ "string[] | undefined" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.ElasticsearchRoleDescriptor.indices", "type": "Array", "tags": [], "label": "indices", "description": [], "signature": [ "{ names: string[]; privileges: string[]; allow_restricted_indices?: boolean | undefined; }[] | undefined" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.ElasticsearchRoleDescriptor.applications", "type": "Array", "tags": [], "label": "applications", "description": [], "signature": [ "{ application: string; privileges: string[]; resources: string[]; }[] | undefined" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.ElasticsearchRoleDescriptor.run_as", "type": "Array", "tags": [], "label": "run_as", "description": [], "signature": [ "string[] | undefined" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.KibanaRole", "type": "Interface", "tags": [], "label": "KibanaRole", "description": [], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.KibanaRole.elasticsearch", "type": "Object", "tags": [], "label": "elasticsearch", "description": [], "signature": [ "{ cluster: string[]; indices: { names: string[]; privileges: string[]; allow_restricted_indices?: boolean | undefined; }[]; }" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.KibanaRole.kibana", "type": "Array", "tags": [], "label": "kibana", "description": [], "signature": [ "{ base: string[]; feature: Record; spaces: string[]; }[]" ], "path": "src/platform/packages/shared/kbn-scout/src/common/services/custom_role.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator", "type": "Interface", "tags": [], "label": "Locator", "description": [ "\nLocators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a\nway to find element(s) on the page at any moment. A locator can be created with the\n[page.locator(selector[, options])](https://playwright.dev/docs/api/class-page#page-locator) method.\n\n[Learn more about locators](https://playwright.dev/docs/locators)." ], "signature": [ "Locator" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate", "type": "Function", "tags": [], "label": "evaluate", "description": [ "\nExecute JavaScript code in the page, taking the matching element as an argument.\n\n**Details**\n\nReturns the return value of\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression), called with the\nmatching element as a first argument, and\n[`arg`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-arg) as a second argument.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression) returns a\n[Promise], this method will wait for the promise to resolve and return its value.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression) throws or\nrejects, this method throws.\n\n**Usage**\n\n```js\nconst tweets = page.locator('.tweet .retweets');\nexpect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');\n```\n" ], "signature": [ "{ (pageFunction: ", "PageFunctionOn", ", arg: Arg, options?: { timeout?: number | undefined; } | undefined): Promise; (pageFunction: ", "PageFunctionOn", ", options?: { timeout?: number | undefined; } | undefined): Promise; }" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate.$1", "type": "CompoundType", "tags": [], "label": "pageFunction", "description": [ "Function to be evaluated in the page context." ], "signature": [ "PageFunctionOn", "" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate.$2", "type": "Uncategorized", "tags": [], "label": "arg", "description": [ "Optional argument to pass to\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression)." ], "signature": [ "Arg" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate.$3", "type": "Object", "tags": [], "label": "options", "description": [], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate.$3.timeout", "type": "number", "tags": [], "label": "timeout", "description": [], "signature": [ "number | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate", "type": "Function", "tags": [], "label": "evaluate", "description": [ "\nExecute JavaScript code in the page, taking the matching element as an argument.\n\n**Details**\n\nReturns the return value of\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression), called with the\nmatching element as a first argument, and\n[`arg`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-arg) as a second argument.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression) returns a\n[Promise], this method will wait for the promise to resolve and return its value.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression) throws or\nrejects, this method throws.\n\n**Usage**\n\n```js\nconst tweets = page.locator('.tweet .retweets');\nexpect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');\n```\n" ], "signature": [ "{ (pageFunction: ", "PageFunctionOn", ", arg: Arg, options?: { timeout?: number | undefined; } | undefined): Promise; (pageFunction: ", "PageFunctionOn", ", options?: { timeout?: number | undefined; } | undefined): Promise; }" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate.$1", "type": "CompoundType", "tags": [], "label": "pageFunction", "description": [ "Function to be evaluated in the page context." ], "signature": [ "PageFunctionOn", "" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate.$2", "type": "Object", "tags": [], "label": "options", "description": [], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluate.$2.timeout", "type": "number", "tags": [], "label": "timeout", "description": [], "signature": [ "number | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateHandle", "type": "Function", "tags": [], "label": "evaluateHandle", "description": [ "\nExecute JavaScript code in the page, taking the matching element as an argument, and return a\n[JSHandle](https://playwright.dev/docs/api/class-jshandle) with the result.\n\n**Details**\n\nReturns the return value of\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-expression) as\na[JSHandle](https://playwright.dev/docs/api/class-jshandle), called with the matching element as a first argument,\nand [`arg`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-arg) as a second argument.\n\nThe only difference between\n[locator.evaluate(pageFunction[, arg, options])](https://playwright.dev/docs/api/class-locator#locator-evaluate)\nand\n[locator.evaluateHandle(pageFunction[, arg, options])](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle)\nis that\n[locator.evaluateHandle(pageFunction[, arg, options])](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle)\nreturns [JSHandle](https://playwright.dev/docs/api/class-jshandle).\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-expression)\nreturns a [Promise], this method will wait for the promise to resolve and return its value.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-expression) throws\nor rejects, this method throws.\n\nSee [page.evaluateHandle(pageFunction[, arg])](https://playwright.dev/docs/api/class-page#page-evaluate-handle) for\nmore details." ], "signature": [ "{ (pageFunction: ", "PageFunctionOn", ", arg: Arg): Promise<", "SmartHandle", ">; (pageFunction: ", "PageFunctionOn", "): Promise<", "SmartHandle", ">; }" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateHandle.$1", "type": "CompoundType", "tags": [], "label": "pageFunction", "description": [ "Function to be evaluated in the page context." ], "signature": [ "PageFunctionOn", "" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateHandle.$2", "type": "Uncategorized", "tags": [], "label": "arg", "description": [ "Optional argument to pass to\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-expression)." ], "signature": [ "Arg" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateHandle", "type": "Function", "tags": [], "label": "evaluateHandle", "description": [ "\nExecute JavaScript code in the page, taking the matching element as an argument, and return a\n[JSHandle](https://playwright.dev/docs/api/class-jshandle) with the result.\n\n**Details**\n\nReturns the return value of\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-expression) as\na[JSHandle](https://playwright.dev/docs/api/class-jshandle), called with the matching element as a first argument,\nand [`arg`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-arg) as a second argument.\n\nThe only difference between\n[locator.evaluate(pageFunction[, arg, options])](https://playwright.dev/docs/api/class-locator#locator-evaluate)\nand\n[locator.evaluateHandle(pageFunction[, arg, options])](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle)\nis that\n[locator.evaluateHandle(pageFunction[, arg, options])](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle)\nreturns [JSHandle](https://playwright.dev/docs/api/class-jshandle).\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-expression)\nreturns a [Promise], this method will wait for the promise to resolve and return its value.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle-option-expression) throws\nor rejects, this method throws.\n\nSee [page.evaluateHandle(pageFunction[, arg])](https://playwright.dev/docs/api/class-page#page-evaluate-handle) for\nmore details." ], "signature": [ "{ (pageFunction: ", "PageFunctionOn", ", arg: Arg): Promise<", "SmartHandle", ">; (pageFunction: ", "PageFunctionOn", "): Promise<", "SmartHandle", ">; }" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateHandle.$1", "type": "CompoundType", "tags": [], "label": "pageFunction", "description": [ "Function to be evaluated in the page context." ], "signature": [ "PageFunctionOn", "" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateAll", "type": "Function", "tags": [], "label": "evaluateAll", "description": [ "\nExecute JavaScript code in the page, taking all matching elements as an argument.\n\n**Details**\n\nReturns the return value of\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-expression), called with\nan array of all matching elements as a first argument, and\n[`arg`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-arg) as a second argument.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-expression) returns a\n[Promise], this method will wait for the promise to resolve and return its value.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-expression) throws or\nrejects, this method throws.\n\n**Usage**\n\n```js\nconst locator = page.locator('div');\nconst moreThanTen = await locator.evaluateAll((divs, min) => divs.length > min, 10);\n```\n" ], "signature": [ "{ (pageFunction: ", "PageFunctionOn", ", arg: Arg): Promise; (pageFunction: ", "PageFunctionOn", "): Promise; }" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateAll.$1", "type": "CompoundType", "tags": [], "label": "pageFunction", "description": [ "Function to be evaluated in the page context." ], "signature": [ "PageFunctionOn", "" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateAll.$2", "type": "Uncategorized", "tags": [], "label": "arg", "description": [ "Optional argument to pass to\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-expression)." ], "signature": [ "Arg" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateAll", "type": "Function", "tags": [], "label": "evaluateAll", "description": [ "\nExecute JavaScript code in the page, taking all matching elements as an argument.\n\n**Details**\n\nReturns the return value of\n[`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-expression), called with\nan array of all matching elements as a first argument, and\n[`arg`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-arg) as a second argument.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-expression) returns a\n[Promise], this method will wait for the promise to resolve and return its value.\n\nIf [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all-option-expression) throws or\nrejects, this method throws.\n\n**Usage**\n\n```js\nconst locator = page.locator('div');\nconst moreThanTen = await locator.evaluateAll((divs, min) => divs.length > min, 10);\n```\n" ], "signature": [ "{ (pageFunction: ", "PageFunctionOn", ", arg: Arg): Promise; (pageFunction: ", "PageFunctionOn", "): Promise; }" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.evaluateAll.$1", "type": "CompoundType", "tags": [], "label": "pageFunction", "description": [ "Function to be evaluated in the page context." ], "signature": [ "PageFunctionOn", "" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.elementHandle", "type": "Function", "tags": [], "label": "elementHandle", "description": [ "\n**NOTE** Always prefer using [Locator](https://playwright.dev/docs/api/class-locator)s and web assertions over\n[ElementHandle](https://playwright.dev/docs/api/class-elementhandle)s because latter are inherently racy.\n\nResolves given locator to the first matching DOM element. If there are no matching elements, waits for one. If\nmultiple elements match the locator, throws." ], "signature": [ "(options?: { timeout?: number | undefined; } | undefined) => Promise<", "ElementHandle", " | null>" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.elementHandle.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.elementHandle.$1.timeout", "type": "number", "tags": [], "label": "timeout", "description": [], "signature": [ "number | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.all", "type": "Function", "tags": [], "label": "all", "description": [ "\nWhen the locator points to a list of elements, this returns an array of locators, pointing to their respective\nelements.\n\n**NOTE** [locator.all()](https://playwright.dev/docs/api/class-locator#locator-all) does not wait for elements to\nmatch the locator, and instead immediately returns whatever is present in the page.\n\nWhen the list of elements changes dynamically,\n[locator.all()](https://playwright.dev/docs/api/class-locator#locator-all) will produce unpredictable and flaky\nresults.\n\nWhen the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before\ncalling [locator.all()](https://playwright.dev/docs/api/class-locator#locator-all).\n\n**Usage**\n\n```js\nfor (const li of await page.getByRole('listitem').all())\n await li.click();\n```\n" ], "signature": [ "() => Promise<", "Locator", "[]>" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.allInnerTexts", "type": "Function", "tags": [], "label": "allInnerTexts", "description": [ "\nReturns an array of `node.innerText` values for all matching nodes.\n\n**NOTE** If you need to assert text on the page, prefer\n[expect(locator).toHaveText(expected[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-have-text)\nwith\n[`useInnerText`](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-have-text-option-use-inner-text)\noption to avoid flakiness. See [assertions guide](https://playwright.dev/docs/test-assertions) for more details.\n\n**Usage**\n\n```js\nconst texts = await page.getByRole('link').allInnerTexts();\n```\n" ], "signature": [ "() => Promise" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.allTextContents", "type": "Function", "tags": [], "label": "allTextContents", "description": [ "\nReturns an array of `node.textContent` values for all matching nodes.\n\n**NOTE** If you need to assert text on the page, prefer\n[expect(locator).toHaveText(expected[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-have-text)\nto avoid flakiness. See [assertions guide](https://playwright.dev/docs/test-assertions) for more details.\n\n**Usage**\n\n```js\nconst texts = await page.getByRole('link').allTextContents();\n```\n" ], "signature": [ "() => Promise" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.and", "type": "Function", "tags": [], "label": "and", "description": [ "\nCreates a locator that matches both this locator and the argument locator.\n\n**Usage**\n\nThe following example finds a button with a specific title.\n\n```js\nconst button = page.getByRole('button').and(page.getByTitle('Subscribe'));\n```\n" ], "signature": [ "(locator: ", "Locator", ") => ", "Locator" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.and.$1", "type": "Object", "tags": [], "label": "locator", "description": [ "Additional locator to match." ], "signature": [ "Locator" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.ariaSnapshot", "type": "Function", "tags": [], "label": "ariaSnapshot", "description": [ "\nCaptures the aria snapshot of the given element. Read more about [aria snapshots](https://playwright.dev/docs/aria-snapshots) and\n[expect(locator).toMatchAriaSnapshot(expected[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot)\nfor the corresponding assertion.\n\n**Usage**\n\n```js\nawait page.getByRole('link').ariaSnapshot();\n```\n\n**Details**\n\nThis method captures the aria snapshot of the given element. The snapshot is a string that represents the state of\nthe element and its children. The snapshot can be used to assert the state of the element in the test, or to\ncompare it to state in the future.\n\nThe ARIA snapshot is represented using [YAML](https://yaml.org/spec/1.2.2/) markup language:\n- The keys of the objects are the roles and optional accessible names of the elements.\n- The values are either text content or an array of child elements.\n- Generic static text can be represented with the `text` key.\n\nBelow is the HTML markup and the respective ARIA snapshot:\n\n```html\n
    \n
  • Home
    • \n
  • About
    • \n
      \n```\n\n```yml\n- list \"Links\":\n - listitem:\n - link \"Home\"\n - listitem:\n - link \"About\"\n```\n" ], "signature": [ "(options?: { timeout?: number | undefined; } | undefined) => Promise" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.ariaSnapshot.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.ariaSnapshot.$1.timeout", "type": "number", "tags": [], "label": "timeout", "description": [ "\nMaximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`\noption in the config, or by using the\n[browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout)\nor [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods." ], "signature": [ "number | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.blur", "type": "Function", "tags": [], "label": "blur", "description": [ "\nCalls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element." ], "signature": [ "(options?: { timeout?: number | undefined; } | undefined) => Promise" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.blur.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.blur.$1.timeout", "type": "number", "tags": [], "label": "timeout", "description": [ "\nMaximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`\noption in the config, or by using the\n[browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout)\nor [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods." ], "signature": [ "number | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.boundingBox", "type": "Function", "tags": [], "label": "boundingBox", "description": [ "\nThis method returns the bounding box of the element matching the locator, or `null` if the element is not visible.\nThe bounding box is calculated relative to the main frame viewport - which is usually the same as the browser\nwindow.\n\n**Details**\n\nScrolling affects the returned bounding box, similarly to\n[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).\nThat means `x` and/or `y` may be negative.\n\nElements from child frames return the bounding box relative to the main frame, unlike the\n[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).\n\nAssuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the\nfollowing snippet should click the center of the element.\n\n**Usage**\n\n```js\nconst box = await page.getByRole('button').boundingBox();\nawait page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);\n```\n" ], "signature": [ "(options?: { timeout?: number | undefined; } | undefined) => Promise<{ x: number; y: number; width: number; height: number; } | null>" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.boundingBox.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.boundingBox.$1.timeout", "type": "number", "tags": [], "label": "timeout", "description": [ "\nMaximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`\noption in the config, or by using the\n[browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout)\nor [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods." ], "signature": [ "number | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.check", "type": "Function", "tags": [], "label": "check", "description": [ "\nEnsure that checkbox or radio element is checked.\n\n**Details**\n\nPerforms the following steps:\n1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already\n checked, this method returns immediately.\n1. Wait for [actionability](https://playwright.dev/docs/actionability) checks on the element, unless\n [`force`](https://playwright.dev/docs/api/class-locator#locator-check-option-force) option is set.\n1. Scroll the element into view if needed.\n1. Use [page.mouse](https://playwright.dev/docs/api/class-page#page-mouse) to click in the center of the\n element.\n1. Ensure that the element is now checked. If not, this method throws.\n\nIf the element is detached from the DOM at any moment during the action, this method throws.\n\nWhen all steps combined have not finished during the specified\n[`timeout`](https://playwright.dev/docs/api/class-locator#locator-check-option-timeout), this method throws a\n[TimeoutError](https://playwright.dev/docs/api/class-timeouterror). Passing zero timeout disables this.\n\n**Usage**\n\n```js\nawait page.getByRole('checkbox').check();\n```\n" ], "signature": [ "(options?: { force?: boolean | undefined; noWaitAfter?: boolean | undefined; position?: { x: number; y: number; } | undefined; timeout?: number | undefined; trial?: boolean | undefined; } | undefined) => Promise" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.check.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.check.$1.force", "type": "CompoundType", "tags": [], "label": "force", "description": [ "\nWhether to bypass the [actionability](https://playwright.dev/docs/actionability) checks. Defaults to `false`." ], "signature": [ "boolean | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.check.$1.noWaitAfter", "type": "CompoundType", "tags": [ "deprecated" ], "label": "noWaitAfter", "description": [ "\nThis option has no effect." ], "signature": [ "boolean | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.check.$1.position", "type": "Object", "tags": [], "label": "position", "description": [ "\nA point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of\nthe element." ], "signature": [ "{ x: number; y: number; } | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.check.$1.timeout", "type": "number", "tags": [], "label": "timeout", "description": [ "\nMaximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`\noption in the config, or by using the\n[browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout)\nor [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods." ], "signature": [ "number | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.check.$1.trial", "type": "CompoundType", "tags": [], "label": "trial", "description": [ "\nWhen set, this method only performs the [actionability](https://playwright.dev/docs/actionability) checks and skips the action. Defaults\nto `false`. Useful to wait until the element is ready for the action without performing it." ], "signature": [ "boolean | undefined" ], "path": "node_modules/playwright/node_modules/playwright-core/types/types.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/scout", "id": "def-common.Locator.clear", "type": "Function", "tags": [], "label": "clear", "description": [ "\nClear the input field.\n\n**Details**\n\nThis method waits for [actionability](https://playwright.dev/docs/actionability) checks, focuses the element, clears it and triggers an\n`input` event after clearing.\n\nIf the target element is not an ``, `