github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-22 08:49:27 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_test.devdocs.json

5317 lines
No EOL
180 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/test",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config",
"type": "Class",
"tags": [],
"label": "Config",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.path",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.module",
"type": "CompoundType",
"tags": [],
"label": "module",
"description": [],
"signature": [
"{ type: \"config\"; path: string; provider: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.FtrConfigProvider",
"text": "FtrConfigProvider"
},
"; } | { type: \"journey\"; path: string; provider: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.FtrConfigProvider",
"text": "FtrConfigProvider"
},
"; journey: Journey; }"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Options"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.has",
"type": "Function",
"tags": [],
"label": "has",
"description": [],
"signature": [
"(key: string | string[]) => boolean"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.has.$1",
"type": "CompoundType",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string | string[]"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(key: string | string[], defaultValue?: any) => any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.get.$1",
"type": "CompoundType",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string | string[]"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.get.$2",
"type": "Any",
"tags": [],
"label": "defaultValue",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Config.getAll",
"type": "Function",
"tags": [],
"label": "getAll",
"description": [],
"signature": [
"() => any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService",
"type": "Class",
"tags": [],
"label": "DockerServersService",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "configs",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.Unnamed.$1.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[name: string]: DockerServerSpec",
"description": [],
"signature": [
"[name: string]: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServerSpec",
"text": "DockerServerSpec"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.Unnamed.$3",
"type": "Object",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.isEnabled",
"type": "Function",
"tags": [],
"label": "isEnabled",
"description": [],
"signature": [
"(name: string) => boolean"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.isEnabled.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.has",
"type": "Function",
"tags": [],
"label": "has",
"description": [],
"signature": [
"(name: string) => boolean"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.has.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(name: string) => { name: string; url: string; enabled: boolean; portInContainer: number; port: number; image: string; waitForLogLine?: string | RegExp | undefined; waitForLogLineTimeoutMs?: number | undefined; waitFor?: ((server: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServer",
"text": "DockerServer"
},
", logLine$: ",
"Observable",
"<string>) => ",
"Observable",
"<unknown>) | undefined; args?: string[] | undefined; }"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServersService.get.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion",
"type": "Class",
"tags": [],
"label": "EsVersion",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.getDefault",
"type": "Function",
"tags": [],
"label": "getDefault",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.parsed",
"type": "Object",
"tags": [],
"label": "parsed",
"description": [],
"signature": [
"node_modules/@types/semver/classes/semver"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.Unnamed.$1",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.toJSON",
"type": "Function",
"tags": [],
"label": "toJSON",
"description": [],
"signature": [
"() => string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.toString",
"type": "Function",
"tags": [],
"label": "toString",
"description": [],
"signature": [
"() => string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.matchRange",
"type": "Function",
"tags": [],
"label": "matchRange",
"description": [
"\nDetermine if the ES version matches a semver range, like >=7 or ^8.1.0"
],
"signature": [
"(range: string) => boolean"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.matchRange.$1",
"type": "string",
"tags": [],
"label": "range",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.eql",
"type": "Function",
"tags": [],
"label": "eql",
"description": [
"\nDetermine if the ES version matches a specific version, ignores things like -SNAPSHOT"
],
"signature": [
"(version: string) => boolean | null"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsVersion.eql.$1",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/es_version.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner",
"type": "Class",
"tags": [],
"label": "FunctionalTestRunner",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
}
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.Unnamed.$3",
"type": "CompoundType",
"tags": [],
"label": "esVersion",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
" | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.run",
"type": "Function",
"tags": [],
"label": "run",
"description": [],
"signature": [
"(abortSignal?: AbortSignal | undefined) => Promise<any>"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.run.$1",
"type": "Object",
"tags": [],
"label": "abortSignal",
"description": [],
"signature": [
"AbortSignal | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.getTestStats",
"type": "Function",
"tags": [],
"label": "getTestStats",
"description": [],
"signature": [
"() => Promise<{ testCount: number; nonSkippedTestCount: number; testsExcludedByTag: any; } | undefined>"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.simulateMochaDryRun",
"type": "Function",
"tags": [],
"label": "simulateMochaDryRun",
"description": [],
"signature": [
"(mocha: any) => number"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.FunctionalTestRunner.simulateMochaDryRun.$1",
"type": "Any",
"tags": [],
"label": "mocha",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrService",
"type": "Class",
"tags": [],
"label": "GenericFtrService",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.GenericFtrService",
"text": "GenericFtrService"
},
"<ProviderContext>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrService.Unnamed.$1",
"type": "Uncategorized",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
"ProviderContext"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"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/test",
"id": "def-common.KbnClientRequesterError",
"type": "Class",
"tags": [],
"label": "KbnClientRequesterError",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.KbnClientRequesterError",
"text": "KbnClientRequesterError"
},
" extends Error"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientRequesterError.axiosError",
"type": "Object",
"tags": [],
"label": "axiosError",
"description": [],
"signature": [
"AxiosError",
"<unknown, any> | undefined"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientRequesterError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientRequesterError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientRequesterError.Unnamed.$2",
"type": "Unknown",
"tags": [],
"label": "error",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle",
"type": "Class",
"tags": [],
"label": "Lifecycle",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.beforeTests",
"type": "Object",
"tags": [],
"label": "beforeTests",
"description": [
"lifecycle phase that will run handlers once before tests execute"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Suite",
"text": "Suite"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.beforeEachRunnable",
"type": "Object",
"tags": [],
"label": "beforeEachRunnable",
"description": [
"lifecycle phase that runs handlers before each runnable (test and hooks)"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.beforeTestSuite",
"type": "Object",
"tags": [],
"label": "beforeTestSuite",
"description": [
"lifecycle phase that runs handlers before each suite"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Suite",
"text": "Suite"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.beforeEachTest",
"type": "Object",
"tags": [],
"label": "beforeEachTest",
"description": [
"lifecycle phase that runs handlers before each test"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.afterTestSuite",
"type": "Object",
"tags": [],
"label": "afterTestSuite",
"description": [
"lifecycle phase that runs handlers after each suite"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Suite",
"text": "Suite"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.testFailure",
"type": "Object",
"tags": [],
"label": "testFailure",
"description": [
"lifecycle phase that runs handlers after a test fails"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[Error, ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.testHookFailure",
"type": "Object",
"tags": [],
"label": "testHookFailure",
"description": [
"lifecycle phase that runs handlers after a hook fails"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[Error, ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.cleanup",
"type": "Object",
"tags": [],
"label": "cleanup",
"description": [
"lifecycle phase that runs handlers at the very end of execution"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<[]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Lifecycle.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase",
"type": "Class",
"tags": [],
"label": "LifecyclePhase",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.LifecyclePhase",
"text": "LifecyclePhase"
},
"<Args>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.triggered",
"type": "boolean",
"tags": [],
"label": "triggered",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.before$",
"type": "Object",
"tags": [],
"label": "before$",
"description": [],
"signature": [
"Observable",
"<void>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.after$",
"type": "Object",
"tags": [],
"label": "after$",
"description": [],
"signature": [
"Observable",
"<void>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "sub",
"description": [],
"signature": [
"Subscription"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.Unnamed.$2.singular",
"type": "CompoundType",
"tags": [],
"label": "singular",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.add",
"type": "Function",
"tags": [],
"label": "add",
"description": [],
"signature": [
"(fn: (...args: Args) => void | Promise<void>) => void"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.add.$1",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"(...args: Args) => void | Promise<void>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.addSub",
"type": "Function",
"tags": [],
"label": "addSub",
"description": [],
"signature": [
"(sub: ",
"Subscription",
") => void"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.addSub.$1",
"type": "Object",
"tags": [],
"label": "sub",
"description": [],
"signature": [
"Subscription"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.trigger",
"type": "Function",
"tags": [],
"label": "trigger",
"description": [],
"signature": [
"(...args: Args) => Promise<void>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.LifecyclePhase.trigger.$1",
"type": "Uncategorized",
"tags": [],
"label": "args",
"description": [],
"signature": [
"Args"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.createAsyncInstance",
"type": "Function",
"tags": [],
"label": "createAsyncInstance",
"description": [],
"signature": [
"<T>(type: string, name: string, promiseForValue: Promise<T>) => AsyncInstance<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/providers/async_instance.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.createAsyncInstance.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/providers/async_instance.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createAsyncInstance.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/providers/async_instance.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createAsyncInstance.$3",
"type": "Object",
"tags": [],
"label": "promiseForValue",
"description": [],
"signature": [
"Promise<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/providers/async_instance.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createEsClientForFtrConfig",
"type": "Function",
"tags": [],
"label": "createEsClientForFtrConfig",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
", overrides: Omit<",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsClientForTestingOptions",
"text": "EsClientForTestingOptions"
},
", \"esUrl\"> | undefined) => ",
"default"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.createEsClientForFtrConfig.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
}
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createEsClientForFtrConfig.$2",
"type": "Object",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsClientForTestingOptions",
"text": "EsClientForTestingOptions"
},
", \"esUrl\"> | undefined"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createEsClientForTesting",
"type": "Function",
"tags": [],
"label": "createEsClientForTesting",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsClientForTestingOptions",
"text": "EsClientForTestingOptions"
},
") => ",
"default"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.createEsClientForTesting.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsClientForTestingOptions",
"text": "EsClientForTestingOptions"
}
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createRemoteEsClientForFtrConfig",
"type": "Function",
"tags": [],
"label": "createRemoteEsClientForFtrConfig",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
", overrides: Omit<",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsClientForTestingOptions",
"text": "EsClientForTestingOptions"
},
", \"esUrl\"> | undefined) => ",
"default"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.createRemoteEsClientForFtrConfig.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
}
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createRemoteEsClientForFtrConfig.$2",
"type": "Object",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsClientForTestingOptions",
"text": "EsClientForTestingOptions"
},
", \"esUrl\"> | undefined"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.createTestEsCluster",
"type": "Function",
"tags": [],
"label": "createTestEsCluster",
"description": [],
"signature": [
"(options: Options) => ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsTestCluster",
"text": "EsTestCluster"
},
"<Options>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.createTestEsCluster.$1",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Options"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.defineDockerServersConfig",
"type": "Function",
"tags": [],
"label": "defineDockerServersConfig",
"description": [
"\nHelper that helps authors use the type definitions for the section of the FTR config\nunder the `dockerServers` key."
],
"signature": [
"(config: {} | { [name: string]: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServerSpec",
"text": "DockerServerSpec"
},
"; }) => {} | { [name: string]: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServerSpec",
"text": "DockerServerSpec"
},
"; }"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.defineDockerServersConfig.$1",
"type": "CompoundType",
"tags": [],
"label": "config",
"description": [],
"signature": [
"{} | { [name: string]: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServerSpec",
"text": "DockerServerSpec"
},
"; }"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.escapeCdata",
"type": "Function",
"tags": [],
"label": "escapeCdata",
"description": [],
"signature": [
"(input: string) => string"
],
"path": "packages/kbn-test/src/mocha/xml.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.escapeCdata.$1",
"type": "string",
"tags": [],
"label": "input",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/mocha/xml.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.findTestPluginPaths",
"type": "Function",
"tags": [],
"label": "findTestPluginPaths",
"description": [],
"signature": [
"(dirs: string | string[]) => string[]"
],
"path": "packages/kbn-test/src/find_test_plugin_paths.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.findTestPluginPaths.$1",
"type": "CompoundType",
"tags": [],
"label": "dirs",
"description": [],
"signature": [
"string | string[]"
],
"path": "packages/kbn-test/src/find_test_plugin_paths.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.getKibanaCliArg",
"type": "Function",
"tags": [],
"label": "getKibanaCliArg",
"description": [
"\nParse a list of Kibana CLI Arg flags and find the flag with the given name. If the flag has no\nvalue then a boolean will be returned (assumed to be a switch flag). If the flag does have a value\nthat can be parsed by `JSON.stringify()` the parsed result is returned. Otherwise the raw string\nvalue is returned."
],
"signature": [
"(rawFlags: string[], name: string) => ",
"ArgValue",
" | ",
"ArgValue",
"[] | undefined"
],
"path": "packages/kbn-test/src/functional_tests/lib/kibana_cli_args.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.getKibanaCliArg.$1",
"type": "Array",
"tags": [],
"label": "rawFlags",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-test/src/functional_tests/lib/kibana_cli_args.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.getKibanaCliArg.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_tests/lib/kibana_cli_args.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.getKibanaCliLoggers",
"type": "Function",
"tags": [],
"label": "getKibanaCliLoggers",
"description": [
"\nParse the list of Kibana CLI Arg flags and extract the loggers config so that they can be extended\nin a subsequent FTR config"
],
"signature": [
"(rawFlags: string[]) => unknown[]"
],
"path": "packages/kbn-test/src/functional_tests/lib/kibana_cli_args.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.getKibanaCliLoggers.$1",
"type": "Array",
"tags": [],
"label": "rawFlags",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-test/src/functional_tests/lib/kibana_cli_args.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.getUrl",
"type": "Function",
"tags": [
"return"
],
"label": "getUrl",
"description": [
"\nConverts a config and a pathname to a url"
],
"signature": [
"(config: UrlParam, app: UrlParam) => string"
],
"path": "packages/kbn-test/src/jest/get_url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.getUrl.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [
"A url config\nexample:\n{\nprotocol: 'http',\nhostname: 'localhost',\nport: 9220,\nauth: kibanaTestUser.username + ':' + kibanaTestUser.password\n}"
],
"signature": [
"UrlParam"
],
"path": "packages/kbn-test/src/jest/get_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.getUrl.$2",
"type": "Object",
"tags": [],
"label": "app",
"description": [
"The params to append\nexample:\n{\npathname: 'app/kibana',\nhash: '/discover'\n}"
],
"signature": [
"UrlParam"
],
"path": "packages/kbn-test/src/jest/get_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.readConfigFile",
"type": "Function",
"tags": [],
"label": "readConfigFile",
"description": [],
"signature": [
"(log: ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
", esVersion: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
", path: string, settingOverrides: any, extendSettings: (vars: any) => any) => Promise<",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
">"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config_loading.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.readConfigFile.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config_loading.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.readConfigFile.$2",
"type": "Object",
"tags": [],
"label": "esVersion",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config_loading.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.readConfigFile.$3",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config_loading.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.readConfigFile.$4",
"type": "Any",
"tags": [],
"label": "settingOverrides",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config_loading.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.readConfigFile.$5",
"type": "Function",
"tags": [],
"label": "extendSettings",
"description": [],
"signature": [
"(vars: any) => any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config_loading.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runCheckFtrConfigsCli",
"type": "Function",
"tags": [],
"label": "runCheckFtrConfigsCli",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/run_check_ftr_configs_cli.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runCheckJestConfigsCli",
"type": "Function",
"tags": [],
"label": "runCheckJestConfigsCli",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/jest/run_check_jest_configs_cli.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runElasticsearch",
"type": "Function",
"tags": [],
"label": "runElasticsearch",
"description": [],
"signature": [
"(options: RunElasticsearchOptions) => Promise<() => Promise<void>>"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.runElasticsearch.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"RunElasticsearchOptions"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_elasticsearch.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runFtrCli",
"type": "Function",
"tags": [],
"label": "runFtrCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-test/src/functional_test_runner/cli.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runJest",
"type": "Function",
"tags": [],
"label": "runJest",
"description": [],
"signature": [
"(configName: string) => void"
],
"path": "packages/kbn-test/src/jest/run.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.runJest.$1",
"type": "string",
"tags": [],
"label": "configName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/jest/run.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKbnArchiverCli",
"type": "Function",
"tags": [],
"label": "runKbnArchiverCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-test/src/kbn_archiver_cli.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer",
"type": "Function",
"tags": [],
"label": "runKibanaServer",
"description": [],
"signature": [
"(options: { procs: ",
{
"pluginId": "@kbn/dev-proc-runner",
"scope": "common",
"docId": "kibKbnDevProcRunnerPluginApi",
"section": "def-common.ProcRunner",
"text": "ProcRunner"
},
"; config: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; installDir?: string | undefined; extraKbnOpts?: string[] | undefined; logsDir?: string | undefined; onEarlyExit?: ((msg: string) => void) | undefined; }) => Promise<void>"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1.procs",
"type": "Object",
"tags": [],
"label": "procs",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-proc-runner",
"scope": "common",
"docId": "kibKbnDevProcRunnerPluginApi",
"section": "def-common.ProcRunner",
"text": "ProcRunner"
}
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
}
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1.installDir",
"type": "string",
"tags": [],
"label": "installDir",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1.extraKbnOpts",
"type": "Array",
"tags": [],
"label": "extraKbnOpts",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1.logsDir",
"type": "string",
"tags": [],
"label": "logsDir",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1.onEarlyExit",
"type": "Function",
"tags": [],
"label": "onEarlyExit",
"description": [],
"signature": [
"((msg: string) => void) | undefined"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.runKibanaServer.$1.onEarlyExit.$1",
"type": "string",
"tags": [],
"label": "msg",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runTests",
"type": "Function",
"tags": [],
"label": "runTests",
"description": [
"\nRun servers and tests for each config"
],
"signature": [
"(log: ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
", options: { configs: string[]; esVersion: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; bail: boolean; dryRun: boolean; updateBaselines: boolean; updateSnapshots: boolean; logsDir: string | undefined; esFrom: \"source\" | \"snapshot\"; installDir: string | undefined; grep: string | undefined; suiteTags: { include: string[]; exclude: string[]; }; suiteFilters: { include: string[]; exclude: string[]; }; }) => Promise<void>"
],
"path": "packages/kbn-test/src/functional_tests/run_tests/run_tests.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.runTests.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_tests/run_tests/run_tests.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runTests.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ configs: string[]; esVersion: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; bail: boolean; dryRun: boolean; updateBaselines: boolean; updateSnapshots: boolean; logsDir: string | undefined; esFrom: \"source\" | \"snapshot\"; installDir: string | undefined; grep: string | undefined; suiteTags: { include: string[]; exclude: string[]; }; suiteFilters: { include: string[]; exclude: string[]; }; }"
],
"path": "packages/kbn-test/src/functional_tests/run_tests/run_tests.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.runTestsCli",
"type": "Function",
"tags": [],
"label": "runTestsCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-test/src/functional_tests/run_tests/cli.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.setupJUnitReportGeneration",
"type": "Function",
"tags": [],
"label": "setupJUnitReportGeneration",
"description": [],
"signature": [
"(runner: any, options: {}) => void"
],
"path": "packages/kbn-test/src/mocha/junit_report_generation.js",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.setupJUnitReportGeneration.$1",
"type": "Any",
"tags": [],
"label": "runner",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/mocha/junit_report_generation.js",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.setupJUnitReportGeneration.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{}"
],
"path": "packages/kbn-test/src/mocha/junit_report_generation.js",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.startServers",
"type": "Function",
"tags": [],
"label": "startServers",
"description": [],
"signature": [
"(log: ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
", options: { config: string; esFrom: \"source\" | \"snapshot\" | undefined; esVersion: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; installDir: string | undefined; logsDir: string | undefined; }) => Promise<void>"
],
"path": "packages/kbn-test/src/functional_tests/start_servers/start_servers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.startServers.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_tests/start_servers/start_servers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.startServers.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ config: string; esFrom: \"source\" | \"snapshot\" | undefined; esVersion: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; installDir: string | undefined; logsDir: string | undefined; }"
],
"path": "packages/kbn-test/src/functional_tests/start_servers/start_servers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.startServersCli",
"type": "Function",
"tags": [],
"label": "startServersCli",
"description": [
"\nStart servers"
],
"signature": [
"() => void"
],
"path": "packages/kbn-test/src/functional_tests/start_servers/cli.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.uriencode",
"type": "Function",
"tags": [],
"label": "uriencode",
"description": [],
"signature": [
"(strings: TemplateStringsArray, ...values: (string | number | boolean)[]) => string"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.uriencode.$1",
"type": "Object",
"tags": [],
"label": "strings",
"description": [],
"signature": [
"TemplateStringsArray"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.uriencode.$2",
"type": "Array",
"tags": [],
"label": "values",
"description": [],
"signature": [
"(string | number | boolean)[]"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.AsyncInstance",
"type": "Interface",
"tags": [],
"label": "AsyncInstance",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.AsyncInstance",
"text": "AsyncInstance"
},
"<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.AsyncInstance.init",
"type": "Function",
"tags": [],
"label": "init",
"description": [
"\nServices that are initialized async are not ready before the tests execute, so you might need\nto call `init()` and await the promise it returns before interacting with the service"
],
"signature": [
"() => Promise<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions",
"type": "Interface",
"tags": [],
"label": "CreateTestEsClusterOptions",
"description": [],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.clusterName",
"type": "string",
"tags": [],
"label": "clusterName",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.dataArchive",
"type": "string",
"tags": [],
"label": "dataArchive",
"description": [
"\nPath to data archive snapshot to run Elasticsearch with.\nTo prepare the snapshot:\n- run Elasticsearch server\n- index necessary data\n- stop Elasticsearch server\n- go to Elasticsearch folder: cd .es/${ELASTICSEARCH_VERSION}\n- archive data folder: zip -r my_archive.zip data"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.esArgs",
"type": "Array",
"tags": [],
"label": "esArgs",
"description": [
"\nElasticsearch configuration options. These are key/value pairs formatted as:\n`['key.1=val1', 'key.2=val2']`"
],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.esFrom",
"type": "string",
"tags": [],
"label": "esFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.esJavaOpts",
"type": "string",
"tags": [],
"label": "esJavaOpts",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.license",
"type": "CompoundType",
"tags": [],
"label": "license",
"description": [
"\nLicense to run your cluster under. Keep in mind that a `trial` license\nhas an expiration date. If you are using a `dataArchive` with your tests,\nyou'll likely need to use `basic` or `gold` to prevent the test from failing\nwhen the license expires."
],
"signature": [
"\"basic\" | \"gold\" | \"trial\" | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.writeLogsToPath",
"type": "string",
"tags": [],
"label": "writeLogsToPath",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.nodes",
"type": "Array",
"tags": [],
"label": "nodes",
"description": [
"\nNode-specific configuration if you wish to run a multi-node\ncluster. One node will be added for each item in the array.\n\nIf this option is not provided, the config will default\nto a single-node cluster.\n"
],
"signature": [
"TestEsClusterNodesOptions[] | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.password",
"type": "string",
"tags": [],
"label": "password",
"description": [
"\nPassword for the `elastic` user. This is set after the cluster has started.\n\nDefaults to `changeme`."
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.port",
"type": "number",
"tags": [],
"label": "port",
"description": [
"\nPort to run Elasticsearch on. If you configure a\nmulti-node cluster with the `nodes` option, this\nport will be incremented by one for each added node.\n"
],
"signature": [
"number | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.ssl",
"type": "CompoundType",
"tags": [],
"label": "ssl",
"description": [
"\nShould this ES cluster use SSL?"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.transportPort",
"type": "CompoundType",
"tags": [],
"label": "transportPort",
"description": [
"\nExplicit transport port for a single node to run on, or a string port range to use eg. '9300-9400'\ndefaults to the transport port from `packages/kbn-test/src/es/es_test_config.ts`"
],
"signature": [
"string | number | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.onEarlyExit",
"type": "Function",
"tags": [],
"label": "onEarlyExit",
"description": [
"\nReport to the creator of the es-test-cluster that the es node has exitted before stop() was called, allowing\nthis caller to react appropriately. If this is not passed then an uncatchable exception will be thrown"
],
"signature": [
"((msg: string) => void) | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.CreateTestEsClusterOptions.onEarlyExit.$1",
"type": "string",
"tags": [],
"label": "msg",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServer",
"type": "Interface",
"tags": [],
"label": "DockerServer",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServer",
"text": "DockerServer"
},
" extends ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServerSpec",
"text": "DockerServerSpec"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServer.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServer.url",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec",
"type": "Interface",
"tags": [],
"label": "DockerServerSpec",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.portInContainer",
"type": "number",
"tags": [],
"label": "portInContainer",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.port",
"type": "number",
"tags": [],
"label": "port",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.image",
"type": "string",
"tags": [],
"label": "image",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.waitForLogLine",
"type": "CompoundType",
"tags": [],
"label": "waitForLogLine",
"description": [],
"signature": [
"string | RegExp | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.waitForLogLineTimeoutMs",
"type": "number",
"tags": [],
"label": "waitForLogLineTimeoutMs",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.waitFor",
"type": "Function",
"tags": [],
"label": "waitFor",
"description": [
"a function that should return an observable that will allow the tests to execute as soon as it emits anything"
],
"signature": [
"((server: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServer",
"text": "DockerServer"
},
", logLine$: ",
"Observable",
"<string>) => ",
"Observable",
"<unknown>) | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.waitFor.$1",
"type": "Object",
"tags": [],
"label": "server",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServer",
"text": "DockerServer"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.waitFor.$2",
"type": "Object",
"tags": [],
"label": "logLine$",
"description": [],
"signature": [
"Observable",
"<string>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.DockerServerSpec.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsClientForTestingOptions",
"type": "Interface",
"tags": [],
"label": "EsClientForTestingOptions",
"description": [
"options for creating es instances used in functional testing scenarios"
],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsClientForTestingOptions",
"text": "EsClientForTestingOptions"
},
" extends Omit<",
"ClientOptions",
", \"nodes\" | \"node\" | \"tls\">"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsClientForTestingOptions.esUrl",
"type": "string",
"tags": [],
"label": "esUrl",
"description": [
"url of es instance"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsClientForTestingOptions.authOverride",
"type": "Object",
"tags": [],
"label": "authOverride",
"description": [
"overwrite the auth embedded in the url to use a different user in this client instance"
],
"signature": [
"{ username: string; password: string; } | undefined"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsClientForTestingOptions.isCloud",
"type": "CompoundType",
"tags": [],
"label": "isCloud",
"description": [
"\nare we running tests against cloud? this is automatically determined\nby checking for the TEST_CLOUD environment variable but can be overriden\nfor special cases"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-test/src/es/es_client_for_testing.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FtrConfigProviderContext",
"type": "Interface",
"tags": [],
"label": "FtrConfigProviderContext",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.FtrConfigProviderContext.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FtrConfigProviderContext.esVersion",
"type": "Object",
"tags": [],
"label": "esVersion",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
}
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FtrConfigProviderContext.readConfigFile",
"type": "Function",
"tags": [],
"label": "readConfigFile",
"description": [],
"signature": [
"(path: string) => Promise<",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
">"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.FtrConfigProviderContext.readConfigFile.$1",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext",
"type": "Interface",
"tags": [],
"label": "GenericFtrProviderContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.GenericFtrProviderContext",
"text": "GenericFtrProviderContext"
},
"<ServiceProviders, PageObjectProviders, ServiceMap, PageObjectMap>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.hasService",
"type": "Function",
"tags": [],
"label": "hasService",
"description": [
"\nDetermine if a service is avaliable"
],
"signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\" | \"dedicatedTaskRunner\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.hasService.$1",
"type": "CompoundType",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"config\" | \"log\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\" | \"dedicatedTaskRunner\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.hasService",
"type": "Function",
"tags": [],
"label": "hasService",
"description": [],
"signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\" | \"dedicatedTaskRunner\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.hasService.$1",
"type": "Uncategorized",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"K"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.hasService",
"type": "Function",
"tags": [],
"label": "hasService",
"description": [],
"signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\" | \"dedicatedTaskRunner\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.hasService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [
"\nGet the instance of a service, if the service is loaded async and the service needs to be used\noutside of a test/hook, then make sure to call its `.init()` method and await it's promise."
],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"esVersion\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; (serviceName: \"dedicatedTaskRunner\"): ",
"DedicatedTaskRunner",
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"config\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"esVersion\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; (serviceName: \"dedicatedTaskRunner\"): ",
"DedicatedTaskRunner",
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"log\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"esVersion\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; (serviceName: \"dedicatedTaskRunner\"): ",
"DedicatedTaskRunner",
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"lifecycle\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"esVersion\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; (serviceName: \"dedicatedTaskRunner\"): ",
"DedicatedTaskRunner",
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"dockerServers\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"esVersion\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; (serviceName: \"dedicatedTaskRunner\"): ",
"DedicatedTaskRunner",
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"esVersion\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"esVersion\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; (serviceName: \"dedicatedTaskRunner\"): ",
"DedicatedTaskRunner",
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"dedicatedTaskRunner\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"esVersion\"): ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.EsVersion",
"text": "EsVersion"
},
"; (serviceName: \"dedicatedTaskRunner\"): ",
"DedicatedTaskRunner",
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getService.$1",
"type": "Uncategorized",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getPageObject",
"type": "Function",
"tags": [],
"label": "getPageObject",
"description": [
"\nGet the instance of a page object"
],
"signature": [
"<K extends keyof PageObjectMap>(pageObjectName: K) => PageObjectMap[K]"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getPageObject.$1",
"type": "Uncategorized",
"tags": [],
"label": "pageObjectName",
"description": [],
"signature": [
"K"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getPageObjects",
"type": "Function",
"tags": [],
"label": "getPageObjects",
"description": [
"\nGet a map of PageObjects"
],
"signature": [
"<K extends keyof PageObjectMap>(pageObjects: K[]) => Pick<PageObjectMap, K>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.getPageObjects.$1",
"type": "Array",
"tags": [],
"label": "pageObjects",
"description": [],
"signature": [
"K[]"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.loadTestFile",
"type": "Function",
"tags": [],
"label": "loadTestFile",
"description": [
"\nSynchronously load a test file, can be called within a `describe()` block to add\ncommon setup/teardown steps to several suites"
],
"signature": [
"(path: string) => void"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.loadTestFile.$1",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.GenericFtrProviderContext.updateBaselines",
"type": "boolean",
"tags": [],
"label": "updateBaselines",
"description": [
"\nDid the user request that baselines get updated?"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster",
"type": "Interface",
"tags": [],
"label": "ICluster",
"description": [],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.ports",
"type": "Array",
"tags": [],
"label": "ports",
"description": [],
"signature": [
"number[]"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.nodes",
"type": "Array",
"tags": [],
"label": "nodes",
"description": [],
"signature": [
{
"pluginId": "@kbn/es",
"scope": "common",
"docId": "kibKbnEsPluginApi",
"section": "def-common.Cluster",
"text": "Cluster"
},
"[]"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.getStartTimeout",
"type": "Function",
"tags": [],
"label": "getStartTimeout",
"description": [],
"signature": [
"() => number"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.cleanup",
"type": "Function",
"tags": [],
"label": "cleanup",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.getClient",
"type": "Function",
"tags": [],
"label": "getClient",
"description": [],
"signature": [
"() => ",
"default"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ICluster.getHostUrls",
"type": "Function",
"tags": [],
"label": "getHostUrls",
"description": [],
"signature": [
"() => string[]"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientOptions",
"type": "Interface",
"tags": [],
"label": "KbnClientOptions",
"description": [],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientOptions.url",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientOptions.certificateAuthorities",
"type": "Array",
"tags": [],
"label": "certificateAuthorities",
"description": [],
"signature": [
"Buffer[] | undefined"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientOptions.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientOptions.uiSettingDefaults",
"type": "Object",
"tags": [],
"label": "uiSettingDefaults",
"description": [],
"signature": [
"UiSettingValues",
" | undefined"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.KbnClientOptions.importExportBaseDir",
"type": "string",
"tags": [],
"label": "importExportBaseDir",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite",
"type": "Interface",
"tags": [],
"label": "Suite",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Suite",
"text": "Suite"
},
" extends ",
"Runnable"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite._beforeAll",
"type": "Array",
"tags": [],
"label": "_beforeAll",
"description": [],
"signature": [
"Runnable",
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite._beforeEach",
"type": "Array",
"tags": [],
"label": "_beforeEach",
"description": [],
"signature": [
"Runnable",
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite._afterEach",
"type": "Array",
"tags": [],
"label": "_afterEach",
"description": [],
"signature": [
"Runnable",
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite._afterAll",
"type": "Array",
"tags": [],
"label": "_afterAll",
"description": [],
"signature": [
"Runnable",
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.currentTest",
"type": "Object",
"tags": [],
"label": "currentTest",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
" | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.suites",
"type": "Array",
"tags": [],
"label": "suites",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Suite",
"text": "Suite"
},
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.tests",
"type": "Array",
"tags": [],
"label": "tests",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.file",
"type": "string",
"tags": [],
"label": "file",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.parent",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Suite",
"text": "Suite"
},
" | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.eachTest",
"type": "Function",
"tags": [],
"label": "eachTest",
"description": [],
"signature": [
"(cb: (test: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
") => void) => void"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.eachTest.$1",
"type": "Function",
"tags": [],
"label": "cb",
"description": [],
"signature": [
"(test: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
") => void"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.root",
"type": "boolean",
"tags": [],
"label": "root",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Suite.suiteTag",
"type": "string",
"tags": [],
"label": "suiteTag",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Test",
"type": "Interface",
"tags": [],
"label": "Test",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Test",
"text": "Test"
},
" extends ",
"Runnable"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.Test.fullTitle",
"type": "Function",
"tags": [],
"label": "fullTitle",
"description": [],
"signature": [
"() => string"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Test.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Test.file",
"type": "string",
"tags": [],
"label": "file",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Test.parent",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.Suite",
"text": "Suite"
},
" | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Test.isPassed",
"type": "Function",
"tags": [],
"label": "isPassed",
"description": [],
"signature": [
"() => boolean"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.Test.pending",
"type": "CompoundType",
"tags": [],
"label": "pending",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.CI_PARALLEL_PROCESS_PREFIX",
"type": "string",
"tags": [],
"label": "CI_PARALLEL_PROCESS_PREFIX",
"description": [
"\nA prefix string that is unique for each parallel CI process that\nis an empty string outside of CI, so it can be safely injected\ninto strings as a prefix"
],
"path": "packages/kbn-test/src/ci_parallel_process_prefix.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.EsTestCluster",
"type": "Type",
"tags": [],
"label": "EsTestCluster",
"description": [],
"signature": [
"Options[\"nodes\"] extends TestEsClusterNodesOptions[] ? ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.ICluster",
"text": "ICluster"
},
" : ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.ICluster",
"text": "ICluster"
},
" & { getUrl: () => string; }"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.FtrConfigProvider",
"type": "Type",
"tags": [],
"label": "FtrConfigProvider",
"description": [],
"signature": [
"<T>(ctx: ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.FtrConfigProviderContext",
"text": "FtrConfigProviderContext"
},
") => T | Promise<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.FtrConfigProvider.$1",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.FtrConfigProviderContext",
"text": "FtrConfigProviderContext"
}
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.ProvidedType",
"type": "Type",
"tags": [],
"label": "ProvidedType",
"description": [
"\nCovert a Provider type to the instance type it provides"
],
"signature": [
"ReturnType<T> extends Promise<infer X> ? ",
{
"pluginId": "@kbn/test",
"scope": "common",
"docId": "kibKbnTestPluginApi",
"section": "def-common.AsyncInstance",
"text": "AsyncInstance"
},
"<X> & X : ReturnType<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.adminTestUser",
"type": "Object",
"tags": [],
"label": "adminTestUser",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.adminTestUser.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.adminTestUser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.esTestConfig",
"type": "Object",
"tags": [],
"label": "esTestConfig",
"description": [],
"signature": [
"EsTestConfig"
],
"path": "packages/kbn-test/src/es/es_test_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.kbnTestConfig",
"type": "Object",
"tags": [],
"label": "kbnTestConfig",
"description": [],
"signature": [
"KbnTestConfig"
],
"path": "packages/kbn-test/kbn_test_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.kibanaServerTestUser",
"type": "Object",
"tags": [],
"label": "kibanaServerTestUser",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.kibanaServerTestUser.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.kibanaServerTestUser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.kibanaTestUser",
"type": "Object",
"tags": [],
"label": "kibanaTestUser",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.kibanaTestUser.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.kibanaTestUser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.systemIndicesSuperuser",
"type": "Object",
"tags": [],
"label": "systemIndicesSuperuser",
"description": [
"\nUser with higher privileges than regular superuser role for writing to system indices"
],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-common.systemIndicesSuperuser.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-common.systemIndicesSuperuser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink