github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-21 08:19:33 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_test.json
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564) 
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -04:00

3448 lines
No EOL
116 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/test",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.Config",
"type": "Class",
"tags": [],
"label": "Config",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.Config.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Config.getAll",
"type": "Function",
"tags": [],
"label": "getAll",
"description": [],
"signature": [
"() => any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/config.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.DockerServersService",
"type": "Class",
"tags": [],
"label": "DockerServersService",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.DockerServersService.Unnamed.$1.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.DockerServersService.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.DockerServersService.Unnamed.$3",
"type": "Object",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/docker_servers_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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; waitFor?: ((server: ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata",
"type": "Class",
"tags": [],
"label": "FailureMetadata",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.add",
"type": "Function",
"tags": [],
"label": "add",
"description": [],
"signature": [
"(metadata: Metadata | ((current: Metadata) => Metadata)) => void"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.add.$1",
"type": "CompoundType",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"Metadata | ((current: Metadata) => Metadata)"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.addMessages",
"type": "Function",
"tags": [],
"label": "addMessages",
"description": [],
"signature": [
"(messages: string[]) => void"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.addMessages.$1",
"type": "Array",
"tags": [],
"label": "messages",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.addScreenshot",
"type": "Function",
"tags": [],
"label": "addScreenshot",
"description": [],
"signature": [
"(name: string, repoPath: string) => { name: string; url: string; } | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.addScreenshot.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [
"Name to label the URL with"
],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.addScreenshot.$2",
"type": "string",
"tags": [],
"label": "repoPath",
"description": [
"absolute path, within the repo, that will be uploaded"
],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(runnable: any) => Metadata | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FailureMetadata.get.$1",
"type": "Any",
"tags": [],
"label": "runnable",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner",
"type": "Class",
"tags": [],
"label": "FunctionalTestRunner",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.lifecycle",
"type": "Object",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
}
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.failureMetadata",
"type": "Object",
"tags": [],
"label": "failureMetadata",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.FailureMetadata",
"text": "FailureMetadata"
}
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.Unnamed.$2",
"type": "string",
"tags": [],
"label": "configFile",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.Unnamed.$3",
"type": "Any",
"tags": [],
"label": "configOverrides",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.run",
"type": "Function",
"tags": [],
"label": "run",
"description": [],
"signature": [
"() => Promise<any>"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.getTestStats",
"type": "Function",
"tags": [],
"label": "getTestStats",
"description": [],
"signature": [
"() => Promise<{ testCount: number; excludedTests: any; }>"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner._run",
"type": "Function",
"tags": [],
"label": "_run",
"description": [],
"signature": [
"<T = any>(handler: (config: ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
", coreProvider: { type: string; name: string; fn: (...args: any[]) => any; }[]) => Promise<T>) => Promise<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner._run.$1",
"type": "Function",
"tags": [],
"label": "handler",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
", coreProvider: { type: string; name: string; fn: (...args: any[]) => any; }[]) => Promise<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FunctionalTestRunner.close",
"type": "Function",
"tags": [],
"label": "close",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrService",
"type": "Class",
"tags": [],
"label": "GenericFtrService",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.GenericFtrService",
"text": "GenericFtrService"
},
"<ProviderContext>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrService.Unnamed.$1",
"type": "Uncategorized",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
"ProviderContext"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient",
"type": "Class",
"tags": [],
"label": "KbnClient",
"description": [],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.status",
"type": "Object",
"tags": [],
"label": "status",
"description": [],
"signature": [
"KbnClientStatus"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.plugins",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"KbnClientPlugins"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.version",
"type": "Object",
"tags": [],
"label": "version",
"description": [],
"signature": [
"KbnClientVersion"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.savedObjects",
"type": "Object",
"tags": [],
"label": "savedObjects",
"description": [],
"signature": [
"KbnClientSavedObjects"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.spaces",
"type": "Object",
"tags": [],
"label": "spaces",
"description": [],
"signature": [
"KbnClientSpaces"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.uiSettings",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [],
"signature": [
"KbnClientUiSettings"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.importExport",
"type": "Object",
"tags": [],
"label": "importExport",
"description": [],
"signature": [
"KbnClientImportExport"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.KbnClientOptions",
"text": "KbnClientOptions"
}
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.request",
"type": "Function",
"tags": [],
"label": "request",
"description": [
"\nMake a direct request to the Kibana server"
],
"signature": [
"<T>(options: ",
"ReqOptions",
") => Promise<",
"AxiosResponse",
"<T>>"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.request.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ReqOptions"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.resolveUrl",
"type": "Function",
"tags": [],
"label": "resolveUrl",
"description": [],
"signature": [
"(relativeUrl: string) => string"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClient.resolveUrl.$1",
"type": "string",
"tags": [],
"label": "relativeUrl",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle",
"type": "Class",
"tags": [],
"label": "Lifecycle",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.beforeTests",
"type": "Object",
"tags": [],
"label": "beforeTests",
"description": [],
"signature": [
"LifecyclePhase",
"<[",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Suite",
"text": "Suite"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.beforeEachRunnable",
"type": "Object",
"tags": [],
"label": "beforeEachRunnable",
"description": [],
"signature": [
"LifecyclePhase",
"<[",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.beforeTestSuite",
"type": "Object",
"tags": [],
"label": "beforeTestSuite",
"description": [],
"signature": [
"LifecyclePhase",
"<[",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Suite",
"text": "Suite"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.beforeEachTest",
"type": "Object",
"tags": [],
"label": "beforeEachTest",
"description": [],
"signature": [
"LifecyclePhase",
"<[",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.afterTestSuite",
"type": "Object",
"tags": [],
"label": "afterTestSuite",
"description": [],
"signature": [
"LifecyclePhase",
"<[",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Suite",
"text": "Suite"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.testFailure",
"type": "Object",
"tags": [],
"label": "testFailure",
"description": [],
"signature": [
"LifecyclePhase",
"<[Error, ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.testHookFailure",
"type": "Object",
"tags": [],
"label": "testHookFailure",
"description": [],
"signature": [
"LifecyclePhase",
"<[Error, ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Test",
"text": "Test"
},
"]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Lifecycle.cleanup",
"type": "Object",
"tags": [],
"label": "cleanup",
"description": [],
"signature": [
"LifecyclePhase",
"<[]>"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.createTestEsCluster",
"type": "Function",
"tags": [],
"label": "createTestEsCluster",
"description": [],
"signature": [
"(options: Options) => ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.EsTestCluster",
"text": "EsTestCluster"
},
"<Options>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.createTestEsCluster.$1",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Options"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServerSpec",
"text": "DockerServerSpec"
},
"; }) => {} | { [name: string]: ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServerSpec",
"text": "DockerServerSpec"
},
"; }"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.defineDockerServersConfig.$1",
"type": "CompoundType",
"tags": [],
"label": "config",
"description": [],
"signature": [
"{} | { [name: string]: ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServerSpec",
"text": "DockerServerSpec"
},
"; }"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.escapeCdata",
"type": "Function",
"tags": [],
"label": "escapeCdata",
"description": [],
"signature": [
"(input: string) => string"
],
"path": "packages/kbn-test/src/mocha/xml.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.escapeCdata.$1",
"type": "string",
"tags": [],
"label": "input",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/mocha/xml.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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/utils/get_url.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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/utils/get_url.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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/utils/get_url.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.readConfigFile",
"type": "Function",
"tags": [],
"label": "readConfigFile",
"description": [],
"signature": [
"(log: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
", path: string, settingOverrides: any) => Promise<",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
">"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/read_config_file.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.readConfigFile.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/read_config_file.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.readConfigFile.$2",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/read_config_file.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.readConfigFile.$3",
"type": "Any",
"tags": [],
"label": "settingOverrides",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-test/src/functional_test_runner/lib/config/read_config_file.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.runCheckJestConfigsCli",
"type": "Function",
"tags": [],
"label": "runCheckJestConfigsCli",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/jest/run_check_jest_configs_cli.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.runFailedTestsReporterCli",
"type": "Function",
"tags": [],
"label": "runFailedTestsReporterCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.runFtrCli",
"type": "Function",
"tags": [],
"label": "runFtrCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-test/src/functional_test_runner/cli.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.runJest",
"type": "Function",
"tags": [],
"label": "runJest",
"description": [],
"signature": [
"(configName: string) => void"
],
"path": "packages/kbn-test/src/jest/run.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.runJest.$1",
"type": "string",
"tags": [],
"label": "configName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/jest/run.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.runKbnArchiverCli",
"type": "Function",
"tags": [],
"label": "runKbnArchiverCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-test/src/kbn_archiver_cli.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.runTests",
"type": "Function",
"tags": [],
"label": "runTests",
"description": [],
"signature": [
"(options: RunTestsParams) => Promise<void>"
],
"path": "packages/kbn-test/src/functional_tests/tasks.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.runTests.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"RunTestsParams"
],
"path": "packages/kbn-test/src/functional_tests/tasks.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.startServers",
"type": "Function",
"tags": [],
"label": "startServers",
"description": [],
"signature": [
"({ ...options }: StartServerOptions) => Promise<void>"
],
"path": "packages/kbn-test/src/functional_tests/tasks.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.startServers.$1",
"type": "Object",
"tags": [],
"label": "{ ...options }",
"description": [],
"signature": [
"StartServerOptions"
],
"path": "packages/kbn-test/src/functional_tests/tasks.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.uriencode",
"type": "Function",
"tags": [],
"label": "uriencode",
"description": [],
"signature": [
"(strings: TemplateStringsArray, ...values: ",
"PhraseFilterValue",
"[]) => string"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.uriencode.$1",
"type": "Object",
"tags": [],
"label": "strings",
"description": [],
"signature": [
"TemplateStringsArray"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.uriencode.$2",
"type": "Array",
"tags": [],
"label": "values",
"description": [],
"signature": [
"PhraseFilterValue",
"[]"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client_requester.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.AsyncInstance",
"type": "Interface",
"tags": [],
"label": "AsyncInstance",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.AsyncInstance",
"text": "AsyncInstance"
},
"<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions",
"type": "Interface",
"tags": [],
"label": "CreateTestEsClusterOptions",
"description": [],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions.clusterName",
"type": "string",
"tags": [],
"label": "clusterName",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions.dataArchive",
"type": "string",
"tags": [],
"label": "dataArchive",
"description": [
"\nPath to data archive snapshot to run Elasticsearch with.\nTo prepare the 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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions.esFrom",
"type": "string",
"tags": [],
"label": "esFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions.esJavaOpts",
"type": "string",
"tags": [],
"label": "esJavaOpts",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.CreateTestEsClusterOptions.ssl",
"type": "CompoundType",
"tags": [],
"label": "ssl",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.DockerServer",
"type": "Interface",
"tags": [],
"label": "DockerServer",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServer",
"text": "DockerServer"
},
" extends ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServerSpec",
"text": "DockerServerSpec"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.DockerServerSpec.waitFor.$1",
"type": "Object",
"tags": [],
"label": "server",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServer",
"text": "DockerServer"
}
],
"path": "packages/kbn-test/src/functional_test_runner/lib/docker_servers/define_docker_servers_config.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FtrConfigProviderContext",
"type": "Interface",
"tags": [],
"label": "FtrConfigProviderContext",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FtrConfigProviderContext.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.FtrConfigProviderContext.readConfigFile",
"type": "Function",
"tags": [],
"label": "readConfigFile",
"description": [],
"signature": [
"(path: string) => Promise<",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
">"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.FtrConfigProviderContext.readConfigFile.$1",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext",
"type": "Interface",
"tags": [],
"label": "GenericFtrProviderContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.GenericFtrProviderContext",
"text": "GenericFtrProviderContext"
},
"<ServiceProviders, PageObjectProviders, ServiceMap, PageObjectMap>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.hasService",
"type": "Function",
"tags": [],
"label": "hasService",
"description": [
"\nDetermine if a service is avaliable"
],
"signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): 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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.hasService.$1",
"type": "CompoundType",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.hasService",
"type": "Function",
"tags": [],
"label": "hasService",
"description": [],
"signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): 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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.hasService.$1",
"type": "Uncategorized",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"K"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.hasService",
"type": "Function",
"tags": [],
"label": "hasService",
"description": [],
"signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): 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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.hasService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"failureMetadata\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.FailureMetadata",
"text": "FailureMetadata"
},
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"config\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"failureMetadata\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.FailureMetadata",
"text": "FailureMetadata"
},
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"log\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"failureMetadata\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.FailureMetadata",
"text": "FailureMetadata"
},
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"lifecycle\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"failureMetadata\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.FailureMetadata",
"text": "FailureMetadata"
},
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"dockerServers\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"failureMetadata\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.FailureMetadata",
"text": "FailureMetadata"
},
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService.$1",
"type": "string",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"\"failureMetadata\""
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [],
"signature": [
"{ (serviceName: \"config\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Config",
"text": "Config"
},
"; (serviceName: \"log\"): ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
"; (serviceName: \"lifecycle\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Lifecycle",
"text": "Lifecycle"
},
"; (serviceName: \"dockerServers\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.DockerServersService",
"text": "DockerServersService"
},
"; (serviceName: \"failureMetadata\"): ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.FailureMetadata",
"text": "FailureMetadata"
},
"; <T extends keyof ServiceMap>(serviceName: T): ServiceMap[T]; }"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getService.$1",
"type": "Uncategorized",
"tags": [],
"label": "serviceName",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getPageObject.$1",
"type": "Uncategorized",
"tags": [],
"label": "pageObjectName",
"description": [],
"signature": [
"K"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.getPageObjects.$1",
"type": "Array",
"tags": [],
"label": "pageObjects",
"description": [],
"signature": [
"K[]"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.GenericFtrProviderContext.loadTestFile.$1",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster",
"type": "Interface",
"tags": [],
"label": "ICluster",
"description": [],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.ports",
"type": "Array",
"tags": [],
"label": "ports",
"description": [],
"signature": [
"number[]"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.nodes",
"type": "Array",
"tags": [],
"label": "nodes",
"description": [],
"signature": [
"Node[]"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.getStartTimeout",
"type": "Function",
"tags": [],
"label": "getStartTimeout",
"description": [],
"signature": [
"() => number"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.cleanup",
"type": "Function",
"tags": [],
"label": "cleanup",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.getClient",
"type": "Function",
"tags": [],
"label": "getClient",
"description": [],
"signature": [
"() => ",
"KibanaClient"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.getHostUrls",
"type": "Function",
"tags": [],
"label": "getHostUrls",
"description": [],
"signature": [
"() => string[]"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClientOptions",
"type": "Interface",
"tags": [],
"label": "KbnClientOptions",
"description": [],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClientOptions.url",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClientOptions.certificateAuthorities",
"type": "Array",
"tags": [],
"label": "certificateAuthorities",
"description": [],
"signature": [
"Buffer[] | undefined"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClientOptions.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClientOptions.uiSettingDefaults",
"type": "Object",
"tags": [],
"label": "uiSettingDefaults",
"description": [],
"signature": [
"Record<string, ",
"PhraseFilterValue",
"> | undefined"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KbnClientOptions.importExportBaseDir",
"type": "string",
"tags": [],
"label": "importExportBaseDir",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-test/src/kbn_client/kbn_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite",
"type": "Interface",
"tags": [],
"label": "Suite",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.suites",
"type": "Array",
"tags": [],
"label": "suites",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Suite",
"text": "Suite"
},
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.tests",
"type": "Array",
"tags": [],
"label": "tests",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Test",
"text": "Test"
},
"[]"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.file",
"type": "string",
"tags": [],
"label": "file",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.parent",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Suite",
"text": "Suite"
},
" | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.eachTest",
"type": "Function",
"tags": [],
"label": "eachTest",
"description": [],
"signature": [
"(cb: (test: ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Test",
"text": "Test"
},
") => void) => void"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.eachTest.$1",
"type": "Function",
"tags": [],
"label": "cb",
"description": [],
"signature": [
"(test: ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Test",
"text": "Test"
},
") => void"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.root",
"type": "boolean",
"tags": [],
"label": "root",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Suite.suiteTag",
"type": "string",
"tags": [],
"label": "suiteTag",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Test",
"type": "Interface",
"tags": [],
"label": "Test",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.Test.fullTitle",
"type": "Function",
"tags": [],
"label": "fullTitle",
"description": [],
"signature": [
"() => string"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Test.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Test.parent",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.Suite",
"text": "Suite"
},
" | undefined"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.Test.isPassed",
"type": "Function",
"tags": [],
"label": "isPassed",
"description": [],
"signature": [
"() => boolean"
],
"path": "packages/kbn-test/src/functional_test_runner/fake_mocha_types.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.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,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.EsTestCluster",
"type": "Type",
"tags": [],
"label": "EsTestCluster",
"description": [],
"signature": [
"Options[\"nodes\"] extends TestEsClusterNodesOptions[] ? ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.ICluster",
"text": "ICluster"
},
" : ",
{
"pluginId": "@kbn/test",
"scope": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.ICluster",
"text": "ICluster"
},
" & { getUrl: () => string; }"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.KIBANA_ROOT",
"type": "string",
"tags": [],
"label": "KIBANA_ROOT",
"description": [],
"path": "packages/kbn-test/src/functional_tests/lib/paths.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.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": "server",
"docId": "kibKbnTestPluginApi",
"section": "def-server.AsyncInstance",
"text": "AsyncInstance"
},
"<X> & X : ReturnType<T>"
],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.adminTestUser",
"type": "Object",
"tags": [],
"label": "adminTestUser",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.adminTestUser.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.adminTestUser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.esTestConfig",
"type": "Object",
"tags": [],
"label": "esTestConfig",
"description": [],
"signature": [
"EsTestConfig"
],
"path": "packages/kbn-test/src/es/es_test_config.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.kbnTestConfig",
"type": "Object",
"tags": [],
"label": "kbnTestConfig",
"description": [],
"signature": [
"KbnTestConfig"
],
"path": "packages/kbn-test/src/kbn/kbn_test_config.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.kibanaServerTestUser",
"type": "Object",
"tags": [],
"label": "kibanaServerTestUser",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.kibanaServerTestUser.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.kibanaServerTestUser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.kibanaTestUser",
"type": "Object",
"tags": [],
"label": "kibanaTestUser",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.kibanaTestUser.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.kibanaTestUser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "packages/kbn-test/src/kbn/users.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink