github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_dev_utils.devdocs.json
Brian Seeders f9badeb6a4
[api-docs] Update API docs (#127782)
2022-03-15 11:27:52 -07:00

4845 lines
No EOL
162 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/dev-utils",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient",
"type": "Class",
"tags": [],
"label": "CiStatsClient",
"description": [],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient.fromEnv",
"type": "Function",
"tags": [],
"label": "fromEnv",
"description": [
"\nCreate a CiStatsReporter by inspecting the ENV for the necessary config"
],
"signature": [
"(log: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
") => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsClient",
"text": "CiStatsClient"
}
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient.fromEnv.$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-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Config",
"text": "Config"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient.isEnabled",
"type": "Function",
"tags": [],
"label": "isEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient.getLatestTestGroupStats",
"type": "Function",
"tags": [],
"label": "getLatestTestGroupStats",
"description": [],
"signature": [
"(options: LatestTestGroupStatsOptions) => Promise<LatestTestGroupStatsResp>"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsClient.getLatestTestGroupStats.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"LatestTestGroupStatsOptions"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter",
"type": "Class",
"tags": [],
"label": "CiStatsReporter",
"description": [
"Object that helps report data to the ci-stats service"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.fromEnv",
"type": "Function",
"tags": [],
"label": "fromEnv",
"description": [
"\nCreate a CiStatsReporter by inspecting the ENV for the necessary config"
],
"signature": [
"(log: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
") => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsReporter",
"text": "CiStatsReporter"
}
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.fromEnv.$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-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Config",
"text": "Config"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.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-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.isEnabled",
"type": "Function",
"tags": [],
"label": "isEnabled",
"description": [
"\nDetermine if CI_STATS is explicitly disabled by the environment. To determine\nif the CiStatsReporter has enough information in the environment to send metrics\nfor builds use #hasBuildConfig()."
],
"signature": [
"() => boolean"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.hasBuildConfig",
"type": "Function",
"tags": [],
"label": "hasBuildConfig",
"description": [
"\nDetermines if the CiStatsReporter is disabled by the environment, or properly\nconfigured and able to send stats"
],
"signature": [
"() => boolean"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.timings",
"type": "Function",
"tags": [],
"label": "timings",
"description": [
"\nReport timings data to the ci-stats service. If running in CI then the reporter\nwill include the buildId in the report with the access token, otherwise the timings\ndata will be recorded as anonymous timing data."
],
"signature": [
"(options: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.TimingsOptions",
"text": "TimingsOptions"
},
") => Promise<boolean | undefined>"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.timings.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.TimingsOptions",
"text": "TimingsOptions"
}
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.metrics",
"type": "Function",
"tags": [],
"label": "metrics",
"description": [
"\nReport metrics data to the ci-stats service. If running outside of CI this method\ndoes nothing as metrics can only be reported when associated with a specific CI build."
],
"signature": [
"(metrics: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsMetric",
"text": "CiStatsMetric"
},
"[], options?: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.MetricsOptions",
"text": "MetricsOptions"
},
" | undefined) => Promise<boolean | undefined>"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.metrics.$1",
"type": "Array",
"tags": [],
"label": "metrics",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsMetric",
"text": "CiStatsMetric"
},
"[]"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.metrics.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.MetricsOptions",
"text": "MetricsOptions"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.reportTests",
"type": "Function",
"tags": [],
"label": "reportTests",
"description": [
"\nSend test reports to ci-stats"
],
"signature": [
"({ group, testRuns }: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsReportTestsOptions",
"text": "CiStatsReportTestsOptions"
},
") => Promise<ReportTestsResponse | undefined>"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReporter.reportTests.$1",
"type": "Object",
"tags": [],
"label": "{ group, testRuns }",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsReportTestsOptions",
"text": "CiStatsReportTestsOptions"
}
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner",
"type": "Class",
"tags": [
"class"
],
"label": "ProcRunner",
"description": [
"\n Helper for starting and managing processes. In many ways it resembles the\n API from `grunt_run`, processes are named and can be started, waited for,\n backgrounded once they log something matching a RegExp...\n"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.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-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.run",
"type": "Function",
"tags": [
"property",
"property",
"property",
"property",
"return"
],
"label": "run",
"description": [
"\n Start a process, tracking it by `name`"
],
"signature": [
"(name: string, options: RunOptions) => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.run.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.run.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"RunOptions"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [
"\n Stop a named proc"
],
"signature": [
"(name: string, signal?: NodeJS.Signals) => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.stop.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.stop.$2",
"type": "CompoundType",
"tags": [],
"label": "signal",
"description": [],
"signature": [
"NodeJS.Signals"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.waitForAllToStop",
"type": "Function",
"tags": [
"return"
],
"label": "waitForAllToStop",
"description": [
"\n Wait for all running processes to stop naturally"
],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.teardown",
"type": "Function",
"tags": [
"return"
],
"label": "teardown",
"description": [
"\n Close the ProcRunner and stop all running\n processes with `signal`\n"
],
"signature": [
"(signal?: \"exit\" | NodeJS.Signals) => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ProcRunner.teardown.$1",
"type": "CompoundType",
"tags": [],
"label": "signal",
"description": [],
"signature": [
"\"exit\" | NodeJS.Signals"
],
"path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommands",
"type": "Class",
"tags": [],
"label": "RunWithCommands",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunWithCommands",
"text": "RunWithCommands"
},
"<T>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommands.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommands.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunWithCommandsOptions",
"text": "RunWithCommandsOptions"
},
"<T>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommands.Unnamed.$2",
"type": "Array",
"tags": [],
"label": "commands",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Command",
"text": "Command"
},
"<T>[]"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommands.command",
"type": "Function",
"tags": [],
"label": "command",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Command",
"text": "Command"
},
"<T>) => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunWithCommands",
"text": "RunWithCommands"
},
"<T>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommands.command.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Command",
"text": "Command"
},
"<T>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommands.execute",
"type": "Function",
"tags": [],
"label": "execute",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog",
"type": "Class",
"tags": [],
"label": "ToolingLog",
"description": [],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "writerConfig",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLogTextWriterConfig",
"text": "ToolingLogTextWriterConfig"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLogOptions",
"text": "ToolingLogOptions"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.getIndent",
"type": "Function",
"tags": [],
"label": "getIndent",
"description": [
"\nGet the current indentation level of the ToolingLog"
],
"signature": [
"() => number"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.indent",
"type": "Function",
"tags": [],
"label": "indent",
"description": [],
"signature": [
"{ (delta: number): undefined; <T>(delta: number, block: () => Promise<T>): Promise<T>; <T>(delta: number, block: () => T): T; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.indent.$1",
"type": "number",
"tags": [],
"label": "delta",
"description": [],
"signature": [
"number"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.indent.$2",
"type": "Function",
"tags": [],
"label": "block",
"description": [],
"signature": [
"(() => T | Promise<T>) | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.verbose",
"type": "Function",
"tags": [],
"label": "verbose",
"description": [],
"signature": [
"(...args: any[]) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.verbose.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.debug",
"type": "Function",
"tags": [],
"label": "debug",
"description": [],
"signature": [
"(...args: any[]) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.debug.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.info",
"type": "Function",
"tags": [],
"label": "info",
"description": [],
"signature": [
"(...args: any[]) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.info.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.success",
"type": "Function",
"tags": [],
"label": "success",
"description": [],
"signature": [
"(...args: any[]) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.success.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.warning",
"type": "Function",
"tags": [],
"label": "warning",
"description": [],
"signature": [
"(...args: any[]) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.warning.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.error",
"type": "Function",
"tags": [],
"label": "error",
"description": [],
"signature": [
"(error: string | Error) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.error.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"string | Error"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.write",
"type": "Function",
"tags": [],
"label": "write",
"description": [],
"signature": [
"(...args: any[]) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.write.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.getWriters",
"type": "Function",
"tags": [],
"label": "getWriters",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Writer",
"text": "Writer"
},
"[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.setWriters",
"type": "Function",
"tags": [],
"label": "setWriters",
"description": [],
"signature": [
"(writers: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Writer",
"text": "Writer"
},
"[]) => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.setWriters.$1",
"type": "Array",
"tags": [],
"label": "writers",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Writer",
"text": "Writer"
},
"[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.getWritten$",
"type": "Function",
"tags": [],
"label": "getWritten$",
"description": [],
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
},
">"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.withType",
"type": "Function",
"tags": [],
"label": "withType",
"description": [
"\nCreate a new ToolingLog which sets a different \"type\", allowing messages to be filtered out by \"source\""
],
"signature": [
"(type: string) => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLog.withType.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [
"A string that will be passed along with messages from this logger which can be used to filter messages with `ignoreSources`"
],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogCollectingWriter",
"type": "Class",
"tags": [],
"label": "ToolingLogCollectingWriter",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLogCollectingWriter",
"text": "ToolingLogCollectingWriter"
},
" extends ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLogTextWriter",
"text": "ToolingLogTextWriter"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogCollectingWriter.messages",
"type": "Array",
"tags": [],
"label": "messages",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogCollectingWriter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogCollectingWriter.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "level",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogCollectingWriter.write",
"type": "Function",
"tags": [],
"label": "write",
"description": [
"\nCalled by ToolingLog, extends messages with the source if message includes one."
],
"signature": [
"(msg: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
},
") => boolean"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogCollectingWriter.write.$1",
"type": "Object",
"tags": [],
"label": "msg",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter",
"type": "Class",
"tags": [],
"label": "ToolingLogTextWriter",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLogTextWriter",
"text": "ToolingLogTextWriter"
},
" implements ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Writer",
"text": "Writer"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.level",
"type": "Object",
"tags": [],
"label": "level",
"description": [],
"signature": [
"{ name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.writeTo",
"type": "Object",
"tags": [],
"label": "writeTo",
"description": [],
"signature": [
"{ write(msg: string): void; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLogTextWriterConfig",
"text": "ToolingLogTextWriterConfig"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.write",
"type": "Function",
"tags": [],
"label": "write",
"description": [],
"signature": [
"(msg: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
},
") => boolean"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.write.$1",
"type": "Object",
"tags": [],
"label": "msg",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.write",
"type": "Function",
"tags": [],
"label": "write",
"description": [],
"signature": [
"(writeTo: { write(msg: string): void; }, prefix: string, msg: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
},
") => void"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.write.$1",
"type": "Object",
"tags": [],
"label": "writeTo",
"description": [],
"signature": [
"{ write(msg: string): void; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.write.$2",
"type": "string",
"tags": [],
"label": "prefix",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriter.write.$3",
"type": "Object",
"tags": [],
"label": "msg",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.combineErrors",
"type": "Function",
"tags": [],
"label": "combineErrors",
"description": [],
"signature": [
"(errors: (Error | FailError)[]) => Error"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.combineErrors.$1",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"(Error | FailError)[]"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createAbsolutePathSerializer",
"type": "Function",
"tags": [],
"label": "createAbsolutePathSerializer",
"description": [],
"signature": [
"(rootPath: string, replacement: string) => { test: (value: any) => boolean; serialize: (value: string) => string; }"
],
"path": "packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createAbsolutePathSerializer.$1",
"type": "string",
"tags": [],
"label": "rootPath",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createAbsolutePathSerializer.$2",
"type": "string",
"tags": [],
"label": "replacement",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createAnyInstanceSerializer",
"type": "Function",
"tags": [],
"label": "createAnyInstanceSerializer",
"description": [],
"signature": [
"(Class: Function, name: string | ((instance: any) => string) | undefined) => { test: (v: any) => boolean; serialize: (v: any) => string; }"
],
"path": "packages/kbn-dev-utils/src/serializers/any_instance_serizlizer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createAnyInstanceSerializer.$1",
"type": "Object",
"tags": [],
"label": "Class",
"description": [],
"signature": [
"Function"
],
"path": "packages/kbn-dev-utils/src/serializers/any_instance_serizlizer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createAnyInstanceSerializer.$2",
"type": "CompoundType",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string | ((instance: any) => string) | undefined"
],
"path": "packages/kbn-dev-utils/src/serializers/any_instance_serizlizer.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createFailError",
"type": "Function",
"tags": [],
"label": "createFailError",
"description": [],
"signature": [
"(reason: string, options: FailErrorOptions) => FailError"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createFailError.$1",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createFailError.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"FailErrorOptions"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createFlagError",
"type": "Function",
"tags": [],
"label": "createFlagError",
"description": [],
"signature": [
"(reason: string) => FailError"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createFlagError.$1",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createRecursiveSerializer",
"type": "Function",
"tags": [],
"label": "createRecursiveSerializer",
"description": [],
"signature": [
"(test: (v: any) => boolean, print: (v: any, printRaw: (v: string) => RawPrint) => string | RawPrint) => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }"
],
"path": "packages/kbn-dev-utils/src/serializers/recursive_serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createRecursiveSerializer.$1",
"type": "Function",
"tags": [],
"label": "test",
"description": [],
"signature": [
"(v: any) => boolean"
],
"path": "packages/kbn-dev-utils/src/serializers/recursive_serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createRecursiveSerializer.$2",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(v: any, printRaw: (v: string) => RawPrint) => string | RawPrint"
],
"path": "packages/kbn-dev-utils/src/serializers/recursive_serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createReplaceSerializer",
"type": "Function",
"tags": [],
"label": "createReplaceSerializer",
"description": [],
"signature": [
"(toReplace: string | RegExp, replaceWith: string | Replacer) => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }"
],
"path": "packages/kbn-dev-utils/src/serializers/replace_serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createReplaceSerializer.$1",
"type": "CompoundType",
"tags": [],
"label": "toReplace",
"description": [],
"signature": [
"string | RegExp"
],
"path": "packages/kbn-dev-utils/src/serializers/replace_serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createReplaceSerializer.$2",
"type": "CompoundType",
"tags": [],
"label": "replaceWith",
"description": [],
"signature": [
"string | Replacer"
],
"path": "packages/kbn-dev-utils/src/serializers/replace_serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.createStripAnsiSerializer",
"type": "Function",
"tags": [],
"label": "createStripAnsiSerializer",
"description": [],
"signature": [
"() => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }"
],
"path": "packages/kbn-dev-utils/src/serializers/strip_ansi_serializer.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.diffStrings",
"type": "Function",
"tags": [],
"label": "diffStrings",
"description": [
"\nProduces a diff string which is nicely formatted to show the differences between two strings. This will\nbe a multi-line string so it's generally a good idea to include a `\\n` before this first line of the diff\nif you are concatenating it with another message."
],
"signature": [
"(expected: string, received: string) => string | undefined"
],
"path": "packages/kbn-dev-utils/src/diff_strings.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.diffStrings.$1",
"type": "string",
"tags": [],
"label": "expected",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/diff_strings.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.diffStrings.$2",
"type": "string",
"tags": [],
"label": "received",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/diff_strings.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.extract",
"type": "Function",
"tags": [],
"label": "extract",
"description": [
"\nExtract tar and zip archives using a single function, supporting stripComponents\nfor both archive types, only tested with familiar archives we create so might not\nsupport some weird exotic zip features we don't use in our own snapshot/build tooling"
],
"signature": [
"({\n archivePath,\n targetDir,\n stripComponents = 0,\n setModifiedTimes,\n}: Options) => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/extract.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.extract.$1",
"type": "Object",
"tags": [],
"label": "{\n archivePath,\n targetDir,\n stripComponents = 0,\n setModifiedTimes,\n}",
"description": [],
"signature": [
"Options"
],
"path": "packages/kbn-dev-utils/src/extract.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.getFlags",
"type": "Function",
"tags": [],
"label": "getFlags",
"description": [],
"signature": [
"(argv: string[], flagOptions: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
},
" | undefined, defaultLogLevel: string) => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Flags",
"text": "Flags"
}
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.getFlags.$1",
"type": "Array",
"tags": [],
"label": "argv",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.getFlags.$2",
"type": "Object",
"tags": [],
"label": "flagOptions",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.getFlags.$3",
"type": "string",
"tags": [],
"label": "defaultLogLevel",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.getTimeReporter",
"type": "Function",
"tags": [],
"label": "getTimeReporter",
"description": [],
"signature": [
"(log: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
", group: string) => (startTime: number, id: string, meta: Record<string, any>) => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/report_time.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.getTimeReporter.$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-dev-utils/src/ci_stats_reporter/report_time.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.getTimeReporter.$2",
"type": "string",
"tags": [],
"label": "group",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/report_time.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.isAxiosRequestError",
"type": "Function",
"tags": [],
"label": "isAxiosRequestError",
"description": [],
"signature": [
"(error: any) => error is ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.AxiosRequestError",
"text": "AxiosRequestError"
}
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.isAxiosRequestError.$1",
"type": "Any",
"tags": [],
"label": "error",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.isAxiosResponseError",
"type": "Function",
"tags": [],
"label": "isAxiosResponseError",
"description": [],
"signature": [
"<T = any>(error: any) => error is ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.AxiosResponseError",
"text": "AxiosResponseError"
},
"<T>"
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.isAxiosResponseError.$1",
"type": "Any",
"tags": [],
"label": "error",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.isFailError",
"type": "Function",
"tags": [],
"label": "isFailError",
"description": [],
"signature": [
"(error: any) => boolean"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.isFailError.$1",
"type": "Any",
"tags": [],
"label": "error",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-dev-utils/src/run/fail.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.mergeFlagOptions",
"type": "Function",
"tags": [],
"label": "mergeFlagOptions",
"description": [],
"signature": [
"(global: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
},
", local: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
},
") => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
}
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.mergeFlagOptions.$1",
"type": "Object",
"tags": [],
"label": "global",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
}
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.mergeFlagOptions.$2",
"type": "Object",
"tags": [],
"label": "local",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
}
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.observeLines",
"type": "Function",
"tags": [
"return"
],
"label": "observeLines",
"description": [
"\n Creates an Observable from a Readable Stream that:\n - splits data from `readable` into lines\n - completes when `readable` emits \"end\"\n - fails if `readable` emits \"errors\"\n"
],
"signature": [
"(readable: ",
"Readable",
") => ",
"Observable",
"<string>"
],
"path": "packages/kbn-dev-utils/src/stdio/observe_lines.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.observeLines.$1",
"type": "Object",
"tags": [],
"label": "readable",
"description": [],
"signature": [
"Readable"
],
"path": "packages/kbn-dev-utils/src/stdio/observe_lines.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.observeReadable",
"type": "Function",
"tags": [],
"label": "observeReadable",
"description": [
"\n Produces an Observable from a ReadableSteam that:\n - completes on the first \"end\" event\n - fails on the first \"error\" event"
],
"signature": [
"(readable: ",
"Readable",
") => ",
"Observable",
"<never>"
],
"path": "packages/kbn-dev-utils/src/stdio/observe_readable.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.observeReadable.$1",
"type": "Object",
"tags": [],
"label": "readable",
"description": [],
"signature": [
"Readable"
],
"path": "packages/kbn-dev-utils/src/stdio/observe_readable.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.parseKibanaPlatformPlugin",
"type": "Function",
"tags": [],
"label": "parseKibanaPlatformPlugin",
"description": [],
"signature": [
"(manifestPath: string) => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.KibanaPlatformPlugin",
"text": "KibanaPlatformPlugin"
}
],
"path": "packages/kbn-dev-utils/src/plugins/parse_kibana_platform_plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.parseKibanaPlatformPlugin.$1",
"type": "string",
"tags": [],
"label": "manifestPath",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/plugins/parse_kibana_platform_plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.parseLogLevel",
"type": "Function",
"tags": [],
"label": "parseLogLevel",
"description": [],
"signature": [
"(name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\") => { name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.parseLogLevel.$1",
"type": "CompoundType",
"tags": [],
"label": "name",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.pickLevelFromFlags",
"type": "Function",
"tags": [],
"label": "pickLevelFromFlags",
"description": [],
"signature": [
"(flags: Record<string, string | boolean | string[] | undefined>, options: { default?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; }) => \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.pickLevelFromFlags.$1",
"type": "Object",
"tags": [],
"label": "flags",
"description": [],
"signature": [
"Record<string, string | boolean | string[] | undefined>"
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.pickLevelFromFlags.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.pickLevelFromFlags.$2.default",
"type": "CompoundType",
"tags": [],
"label": "default",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.run",
"type": "Function",
"tags": [],
"label": "run",
"description": [],
"signature": [
"(fn: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunFn",
"text": "RunFn"
},
", options: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunOptions",
"text": "RunOptions"
},
") => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.run.$1",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunFn",
"text": "RunFn"
}
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.run.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunOptions",
"text": "RunOptions"
}
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.runPluginListCli",
"type": "Function",
"tags": [],
"label": "runPluginListCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.runUpdateVscodeConfigCli",
"type": "Function",
"tags": [],
"label": "runUpdateVscodeConfigCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-dev-utils/src/vscode_config/update_vscode_config_cli.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.shipCiStatsCli",
"type": "Function",
"tags": [],
"label": "shipCiStatsCli",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ship_ci_stats_cli.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.simpleKibanaPlatformPluginDiscovery",
"type": "Function",
"tags": [],
"label": "simpleKibanaPlatformPluginDiscovery",
"description": [
"\nHelper to find the new platform plugins."
],
"signature": [
"(scanDirs: string[], pluginPaths: string[]) => ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.KibanaPlatformPlugin",
"text": "KibanaPlatformPlugin"
},
"[]"
],
"path": "packages/kbn-dev-utils/src/plugins/simple_kibana_platform_plugin_discovery.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.simpleKibanaPlatformPluginDiscovery.$1",
"type": "Array",
"tags": [],
"label": "scanDirs",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-dev-utils/src/plugins/simple_kibana_platform_plugin_discovery.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.simpleKibanaPlatformPluginDiscovery.$2",
"type": "Array",
"tags": [],
"label": "pluginPaths",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-dev-utils/src/plugins/simple_kibana_platform_plugin_discovery.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.sortPackageJson",
"type": "Function",
"tags": [],
"label": "sortPackageJson",
"description": [],
"signature": [
"(json: string) => string"
],
"path": "packages/kbn-dev-utils/src/sort_package_json.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.sortPackageJson.$1",
"type": "string",
"tags": [],
"label": "json",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-dev-utils/src/sort_package_json.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.transformFileStream",
"type": "Function",
"tags": [],
"label": "transformFileStream",
"description": [
"\nCreate a transform stream that processes Vinyl fs streams and\ncalls a function for each file, allowing the function to either\nmutate the file, replace it with another file (return a new File\nobject), or drop it from the stream (return null)"
],
"signature": [
"(fn: (file: BufferedFile) => void | ",
"node_modules/@types/vinyl/index",
" | Promise<void | ",
"node_modules/@types/vinyl/index",
" | null> | null) => ",
"Transform"
],
"path": "packages/kbn-dev-utils/src/streams.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.transformFileStream.$1",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"(file: BufferedFile) => void | ",
"node_modules/@types/vinyl/index",
" | Promise<void | ",
"node_modules/@types/vinyl/index",
" | null> | null"
],
"path": "packages/kbn-dev-utils/src/streams.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.transformFileWithBabel",
"type": "Function",
"tags": [],
"label": "transformFileWithBabel",
"description": [
"\nReturns a promise that resolves when the file has been\nmutated so the contents of the file are tranformed with\nbabel, include inline sourcemaps, and the filename has\nbeen updated to use .js.\n\nIf the file was previously transformed with this function\nthe promise will just resolve immediately."
],
"signature": [
"(file: ",
"node_modules/@types/vinyl/index",
") => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/babel.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.transformFileWithBabel.$1",
"type": "Object",
"tags": [],
"label": "file",
"description": [],
"signature": [
"node_modules/@types/vinyl/index"
],
"path": "packages/kbn-dev-utils/src/babel.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.withProcRunner",
"type": "Function",
"tags": [
"return"
],
"label": "withProcRunner",
"description": [
"\n Create a ProcRunner and pass it to an async function. When\n the async function finishes the ProcRunner is torn-down\n automatically\n"
],
"signature": [
"(log: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
", fn: (procs: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ProcRunner",
"text": "ProcRunner"
},
") => Promise<void>) => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.withProcRunner.$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-dev-utils/src/proc_runner/with_proc_runner.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.withProcRunner.$2",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"(procs: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ProcRunner",
"text": "ProcRunner"
},
") => Promise<void>"
],
"path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.AxiosRequestError",
"type": "Interface",
"tags": [],
"label": "AxiosRequestError",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.AxiosRequestError",
"text": "AxiosRequestError"
},
" extends ",
"AxiosError",
"<any>"
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.AxiosRequestError.response",
"type": "Uncategorized",
"tags": [],
"label": "response",
"description": [],
"signature": [
"undefined"
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.AxiosResponseError",
"type": "Interface",
"tags": [],
"label": "AxiosResponseError",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.AxiosResponseError",
"text": "AxiosResponseError"
},
"<T> extends ",
"AxiosError",
"<any>"
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.AxiosResponseError.response",
"type": "Object",
"tags": [],
"label": "response",
"description": [],
"signature": [
"AxiosResponse",
"<T>"
],
"path": "packages/kbn-dev-utils/src/axios/errors.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsMetric",
"type": "Interface",
"tags": [],
"label": "CiStatsMetric",
"description": [
"A ci-stats metric record"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsMetric.group",
"type": "string",
"tags": [],
"label": "group",
"description": [
"Top-level categorization for the metric, e.g. \"page load bundle size\""
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsMetric.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"Specific sub-set of the \"group\", e.g. \"dashboard\""
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsMetric.value",
"type": "number",
"tags": [],
"label": "value",
"description": [
"integer value recorded as the value of this metric"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsMetric.limit",
"type": "number",
"tags": [],
"label": "limit",
"description": [
"optional limit which will generate an error on PRs when the metric exceeds the limit"
],
"signature": [
"number | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsMetric.limitConfigPath",
"type": "string",
"tags": [],
"label": "limitConfigPath",
"description": [
"\npath, relative to the repo, where the config file contianing limits\nis kept. Linked from PR comments instructing contributors how to fix\ntheir PRs."
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsMetric.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [
"Arbitrary key-value pairs which can be used for additional filtering/reporting"
],
"signature": [
"CiStatsMetadata",
" | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReportTestsOptions",
"type": "Interface",
"tags": [],
"label": "CiStatsReportTestsOptions",
"description": [
"Options for reporting tests to ci-stats"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReportTestsOptions.group",
"type": "Object",
"tags": [],
"label": "group",
"description": [
"\nInformation about the group of tests that were run"
],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsTestGroupInfo",
"text": "CiStatsTestGroupInfo"
}
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsReportTestsOptions.testRuns",
"type": "Array",
"tags": [],
"label": "testRuns",
"description": [
"\nInformation about each test that ran, including failure information"
],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsTestRun",
"text": "CiStatsTestRun"
},
"[]"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestGroupInfo",
"type": "Interface",
"tags": [],
"label": "CiStatsTestGroupInfo",
"description": [],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestGroupInfo.startTime",
"type": "string",
"tags": [],
"label": "startTime",
"description": [
"\nISO-8601 formatted datetime representing when the group of tests started running"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestGroupInfo.durationMs",
"type": "number",
"tags": [],
"label": "durationMs",
"description": [
"\nThe number of miliseconds that the tests ran for"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestGroupInfo.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\nThe type of tests run in this group, any value is valid but test groups are groupped by type in the UI so use something consistent"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestGroupInfo.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nThe name of this specific group (within the \"type\")"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestGroupInfo.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [
"\nArbitrary metadata associated with this group. We currently look for a ciGroup metadata property for highlighting that when appropriate"
],
"signature": [
"CiStatsMetadata"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun",
"type": "Interface",
"tags": [],
"label": "CiStatsTestRun",
"description": [],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.startTime",
"type": "string",
"tags": [],
"label": "startTime",
"description": [
"\nISO-8601 formatted datetime representing when the tests started running"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.durationMs",
"type": "number",
"tags": [],
"label": "durationMs",
"description": [
"\nDuration of the tests in milliseconds"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.seq",
"type": "number",
"tags": [],
"label": "seq",
"description": [
"\nA sequence number, this is used to order the tests in a specific test run"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [
"\nThe type of this \"test run\", usually this is just \"test\" but when reporting issues in hooks it can be set to the type of hook"
],
"signature": [
"\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\""
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.result",
"type": "CompoundType",
"tags": [],
"label": "result",
"description": [
"\n\"fail\", \"pass\" or \"skip\", the result of the tests"
],
"signature": [
"\"fail\" | \"pass\" | \"skip\""
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.suites",
"type": "Array",
"tags": [],
"label": "suites",
"description": [
"\nThe list of suite names containing this test, the first being the outermost suite"
],
"signature": [
"string[]"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nThe name of this specific test run"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.file",
"type": "string",
"tags": [],
"label": "file",
"description": [
"\nRelative path from the root of the repo contianing this test"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.error",
"type": "string",
"tags": [],
"label": "error",
"description": [
"\nError message if the test failed"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.stdout",
"type": "string",
"tags": [],
"label": "stdout",
"description": [
"\nDebug output/stdout produced by the test"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestRun.screenshots",
"type": "Array",
"tags": [],
"label": "screenshots",
"description": [
"\nScreenshots captured during the test run"
],
"signature": [
"{ name: string; base64Png: string; }[] | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTiming",
"type": "Interface",
"tags": [],
"label": "CiStatsTiming",
"description": [
"A ci-stats timing event"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTiming.group",
"type": "string",
"tags": [],
"label": "group",
"description": [
"Top-level categorization for the timing, e.g. \"scripts/foo\", process type, etc."
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTiming.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"Specific timing (witin the \"group\" being tracked) e.g. \"total\""
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTiming.ms",
"type": "number",
"tags": [],
"label": "ms",
"description": [
"time in milliseconds which should be recorded"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTiming.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [
"hash of key-value pairs which will be stored with the timing for additional filtering and reporting"
],
"signature": [
"CiStatsMetadata",
" | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Command",
"type": "Interface",
"tags": [],
"label": "Command",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Command",
"text": "Command"
},
"<T>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Command.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Command.run",
"type": "Function",
"tags": [],
"label": "run",
"description": [],
"signature": [
"(context: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
},
" & T) => void | Promise<void>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Command.run.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
},
" & T"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Command.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Command.usage",
"type": "string",
"tags": [],
"label": "usage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Command.flags",
"type": "Object",
"tags": [],
"label": "flags",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Config",
"type": "Interface",
"tags": [],
"label": "Config",
"description": [
"\nInformation about how CiStatsReporter should talk to the ci-stats service. Normally\nit is read from a JSON environment variable using the `parseConfig()` function\nexported by this module."
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_config.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Config.apiToken",
"type": "string",
"tags": [],
"label": "apiToken",
"description": [
"ApiToken necessary for writing build data to ci-stats service"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_config.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Config.buildId",
"type": "string",
"tags": [],
"label": "buildId",
"description": [
"\nuuid which should be obtained by first creating a build with the\nci-stats service and then passing it to all subsequent steps"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_config.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions",
"type": "Interface",
"tags": [],
"label": "FlagOptions",
"description": [],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions.allowUnexpected",
"type": "CompoundType",
"tags": [],
"label": "allowUnexpected",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions.guessTypesForUnexpectedFlags",
"type": "CompoundType",
"tags": [],
"label": "guessTypesForUnexpectedFlags",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions.help",
"type": "string",
"tags": [],
"label": "help",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions.alias",
"type": "Object",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"{ [key: string]: string | string[]; } | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions.boolean",
"type": "Array",
"tags": [],
"label": "boolean",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions.string",
"type": "Array",
"tags": [],
"label": "string",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.FlagOptions.default",
"type": "Object",
"tags": [],
"label": "default",
"description": [],
"signature": [
"{ [key: string]: any; } | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags",
"type": "Interface",
"tags": [],
"label": "Flags",
"description": [],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags.verbose",
"type": "boolean",
"tags": [],
"label": "verbose",
"description": [],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags.quiet",
"type": "boolean",
"tags": [],
"label": "quiet",
"description": [],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags.silent",
"type": "boolean",
"tags": [],
"label": "silent",
"description": [],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags.debug",
"type": "boolean",
"tags": [],
"label": "debug",
"description": [],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags.help",
"type": "boolean",
"tags": [],
"label": "help",
"description": [],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags._",
"type": "Array",
"tags": [],
"label": "_",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags.unexpected",
"type": "Array",
"tags": [],
"label": "unexpected",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Flags.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: string | boolean | string[] | undefined",
"description": [],
"signature": [
"[key: string]: string | boolean | string[] | undefined"
],
"path": "packages/kbn-dev-utils/src/run/flags.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KibanaPlatformPlugin",
"type": "Interface",
"tags": [],
"label": "KibanaPlatformPlugin",
"description": [],
"path": "packages/kbn-dev-utils/src/plugins/parse_kibana_platform_plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KibanaPlatformPlugin.directory",
"type": "string",
"tags": [],
"label": "directory",
"description": [],
"path": "packages/kbn-dev-utils/src/plugins/parse_kibana_platform_plugin.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KibanaPlatformPlugin.manifestPath",
"type": "string",
"tags": [],
"label": "manifestPath",
"description": [],
"path": "packages/kbn-dev-utils/src/plugins/parse_kibana_platform_plugin.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KibanaPlatformPlugin.manifest",
"type": "Object",
"tags": [],
"label": "manifest",
"description": [],
"signature": [
"Manifest"
],
"path": "packages/kbn-dev-utils/src/plugins/parse_kibana_platform_plugin.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Message",
"type": "Interface",
"tags": [],
"label": "Message",
"description": [
"\nThe object shape passed to ToolingLog writers each time the log is used."
],
"path": "packages/kbn-dev-utils/src/tooling_log/message.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Message.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [
"level/type of message"
],
"signature": [
"\"error\" | \"write\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/message.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Message.indent",
"type": "number",
"tags": [],
"label": "indent",
"description": [
"indentation intended when message written to a text log"
],
"path": "packages/kbn-dev-utils/src/tooling_log/message.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Message.source",
"type": "string",
"tags": [],
"label": "source",
"description": [
"type of logger this message came from"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/message.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Message.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [
"args passed to the logging method"
],
"signature": [
"any[]"
],
"path": "packages/kbn-dev-utils/src/tooling_log/message.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.MetricsOptions",
"type": "Interface",
"tags": [],
"label": "MetricsOptions",
"description": [
"Options for reporting metrics to ci-stats"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.MetricsOptions.defaultMeta",
"type": "Object",
"tags": [],
"label": "defaultMeta",
"description": [
"Default metadata to add to each metric"
],
"signature": [
"CiStatsMetadata",
" | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunContext",
"type": "Interface",
"tags": [],
"label": "RunContext",
"description": [],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunContext.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-dev-utils/src/run/run.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunContext.flags",
"type": "Object",
"tags": [],
"label": "flags",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Flags",
"text": "Flags"
}
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunContext.procRunner",
"type": "Object",
"tags": [],
"label": "procRunner",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ProcRunner",
"text": "ProcRunner"
}
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunContext.statsMeta",
"type": "Object",
"tags": [],
"label": "statsMeta",
"description": [],
"signature": [
"Map<string, string | number | boolean>"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunContext.addCleanupTask",
"type": "Function",
"tags": [],
"label": "addCleanupTask",
"description": [],
"signature": [
"(task: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CleanupTask",
"text": "CleanupTask"
},
") => void"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunContext.addCleanupTask.$1",
"type": "Function",
"tags": [],
"label": "task",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CleanupTask",
"text": "CleanupTask"
}
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunOptions",
"type": "Interface",
"tags": [],
"label": "RunOptions",
"description": [],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunOptions.usage",
"type": "string",
"tags": [],
"label": "usage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunOptions.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunOptions.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
"{ defaultLevel?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunOptions.flags",
"type": "Object",
"tags": [],
"label": "flags",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommandsOptions",
"type": "Interface",
"tags": [],
"label": "RunWithCommandsOptions",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunWithCommandsOptions",
"text": "RunWithCommandsOptions"
},
"<T>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommandsOptions.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
"{ defaultLevel?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommandsOptions.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommandsOptions.usage",
"type": "string",
"tags": [],
"label": "usage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommandsOptions.globalFlags",
"type": "Object",
"tags": [],
"label": "globalFlags",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.FlagOptions",
"text": "FlagOptions"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommandsOptions.extendContext",
"type": "Function",
"tags": [],
"label": "extendContext",
"description": [],
"signature": [
"((context: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
},
") => T | Promise<T>) | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunWithCommandsOptions.extendContext.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
}
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.TimingsOptions",
"type": "Interface",
"tags": [],
"label": "TimingsOptions",
"description": [
"Options for reporting timings to ci-stats"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.TimingsOptions.timings",
"type": "Array",
"tags": [],
"label": "timings",
"description": [
"list of timings to record"
],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.CiStatsTiming",
"text": "CiStatsTiming"
},
"[]"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.TimingsOptions.upstreamBranch",
"type": "string",
"tags": [],
"label": "upstreamBranch",
"description": [
"master, 7.x, etc, automatically detected from package.json if not specified"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.TimingsOptions.kibanaUuid",
"type": "CompoundType",
"tags": [],
"label": "kibanaUuid",
"description": [
"value of data/uuid, automatically loaded if not specified"
],
"signature": [
"string | null | undefined"
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogOptions",
"type": "Interface",
"tags": [],
"label": "ToolingLogOptions",
"description": [],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogOptions.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\ntype name for this logger, will be assigned to the \"source\"\nproperties of messages produced by this logger"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogOptions.parent",
"type": "Object",
"tags": [],
"label": "parent",
"description": [
"\nparent ToolingLog. When a ToolingLog has a parent they will both\nshare indent and writers state. Changing the indent width or\nwriters on either log will update the other too."
],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.ToolingLog",
"text": "ToolingLog"
},
" | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriterConfig",
"type": "Interface",
"tags": [],
"label": "ToolingLogTextWriterConfig",
"description": [],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriterConfig.level",
"type": "CompoundType",
"tags": [],
"label": "level",
"description": [
"\nLog level, messages below this level will be ignored"
],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriterConfig.ignoreSources",
"type": "Array",
"tags": [],
"label": "ignoreSources",
"description": [
"\nList of message sources/ToolingLog types which will be ignored. Create\na logger with `ToolingLog#withType()` to create messages with a specific\nsource. Ignored messages will be dropped without writing."
],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ToolingLogTextWriterConfig.writeTo",
"type": "Object",
"tags": [],
"label": "writeTo",
"description": [
"\nTarget which will receive formatted message lines, a common value for `writeTo`\nis process.stdout"
],
"signature": [
"{ write(s: string): void; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Writer",
"type": "Interface",
"tags": [],
"label": "Writer",
"description": [
"\nAn object which received ToolingLog `Messages` and sends them to\nsome interface for collecting logs like stdio, or a file"
],
"path": "packages/kbn-dev-utils/src/tooling_log/writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Writer.write",
"type": "Function",
"tags": [],
"label": "write",
"description": [
"\nCalled with every log message, should return true if the message\nwas written and false if it was ignored."
],
"signature": [
"(msg: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
},
") => boolean"
],
"path": "packages/kbn-dev-utils/src/tooling_log/writer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.Writer.write.$1",
"type": "Object",
"tags": [],
"label": "msg",
"description": [
"The log message to write"
],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.Message",
"text": "Message"
}
],
"path": "packages/kbn-dev-utils/src/tooling_log/writer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CA_CERT_PATH",
"type": "string",
"tags": [],
"label": "CA_CERT_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestResult",
"type": "Type",
"tags": [],
"label": "CiStatsTestResult",
"description": [],
"signature": [
"\"fail\" | \"pass\" | \"skip\""
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CiStatsTestType",
"type": "Type",
"tags": [],
"label": "CiStatsTestType",
"description": [],
"signature": [
"\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\""
],
"path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CleanupTask",
"type": "Type",
"tags": [],
"label": "CleanupTask",
"description": [
"\nA function which will be called when the CLI is torn-down which should\nquickly cleanup whatever it needs."
],
"signature": [
"() => void"
],
"path": "packages/kbn-dev-utils/src/run/cleanup.ts",
"deprecated": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CommandRunFn",
"type": "Type",
"tags": [],
"label": "CommandRunFn",
"description": [],
"signature": [
"(context: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
},
" & T) => void | Promise<void>"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.CommandRunFn.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
},
" & T"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ES_CERT_PATH",
"type": "string",
"tags": [],
"label": "ES_CERT_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ES_EMPTYPASSWORD_P12_PATH",
"type": "string",
"tags": [],
"label": "ES_EMPTYPASSWORD_P12_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ES_KEY_PATH",
"type": "string",
"tags": [],
"label": "ES_KEY_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ES_NOPASSWORD_P12_PATH",
"type": "string",
"tags": [],
"label": "ES_NOPASSWORD_P12_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ES_P12_PASSWORD",
"type": "string",
"tags": [],
"label": "ES_P12_PASSWORD",
"description": [],
"signature": [
"\"storepass\""
],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ES_P12_PATH",
"type": "string",
"tags": [],
"label": "ES_P12_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KBN_CERT_PATH",
"type": "string",
"tags": [],
"label": "KBN_CERT_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KBN_KEY_PATH",
"type": "string",
"tags": [],
"label": "KBN_KEY_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KBN_P12_PASSWORD",
"type": "string",
"tags": [],
"label": "KBN_P12_PASSWORD",
"description": [],
"signature": [
"\"storepass\""
],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.KBN_P12_PATH",
"type": "string",
"tags": [],
"label": "KBN_P12_PATH",
"description": [],
"path": "packages/kbn-dev-utils/src/certs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.LogLevel",
"type": "Type",
"tags": [],
"label": "LogLevel",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.ParsedLogLevel",
"type": "Type",
"tags": [],
"label": "ParsedLogLevel",
"description": [],
"signature": [
"{ name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunFn",
"type": "Type",
"tags": [],
"label": "RunFn",
"description": [],
"signature": [
"(context: ",
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
},
") => void | Promise<void>"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/dev-utils",
"id": "def-server.RunFn.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/dev-utils",
"scope": "server",
"docId": "kibKbnDevUtilsPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
}
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink