{ "id": "@kbn/dev-cli-runner", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader", "type": "Class", "tags": [], "label": "FlagsReader", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.Unnamed.$1", "type": "Object", "tags": [], "label": "flags", "description": [], "signature": [ "Record" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.Unnamed.$2", "type": "Object", "tags": [], "label": "opts", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.Unnamed.$2.aliases", "type": "Object", "tags": [], "label": "aliases", "description": [], "signature": [ "Record | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.arrayOfStrings", "type": "Function", "tags": [], "label": "arrayOfStrings", "description": [ "\nRead a string flag that supports multiple instances into an array of strings. If the\nflag is only passed once an array with a single item will be returned. If the flag is not\npassed then undefined will be returned." ], "signature": [ "(key: string) => string[] | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.arrayOfStrings.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredArrayOfStrings", "type": "Function", "tags": [], "label": "requiredArrayOfStrings", "description": [ "\nSame as #arrayOfStrings() except when the flag is not passed a \"flag error\" is thrown telling\nthe user that the flag is required and shows them the help text." ], "signature": [ "(key: string) => string[]" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredArrayOfStrings.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.string", "type": "Function", "tags": [], "label": "string", "description": [ "\nRead the value of a string flag. If the flag is passed multiple times the last value is returned. If\nthe flag is not passed then undefined is returned." ], "signature": [ "(key: string) => string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.string.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.enum", "type": "Function", "tags": [], "label": "enum", "description": [ "\nSame as #string() except when the flag is passed it is validated against a list\nof valid values" ], "signature": [ "(key: string, values: readonly T[]) => T | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.enum.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.enum.$2", "type": "Object", "tags": [], "label": "values", "description": [], "signature": [ "readonly T[]" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredString", "type": "Function", "tags": [], "label": "requiredString", "description": [ "\nSame as #string() except when a flag is not passed a \"flag error\" is thrown telling the user\nthat the flag is required and shows them the help text." ], "signature": [ "(key: string) => string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredString.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.path", "type": "Function", "tags": [], "label": "path", "description": [ "\nSame as #string(), except that when there is a value for the string it is resolved to an\nabsolute path based on the current working directory" ], "signature": [ "(key: string) => string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.path.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredPath", "type": "Function", "tags": [], "label": "requiredPath", "description": [ "\nSame as #requiredString() except that values are converted to absolute paths based on the\ncurrent working directory" ], "signature": [ "(key: string) => string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredPath.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.arrayOfPaths", "type": "Function", "tags": [], "label": "arrayOfPaths", "description": [ "\nSame as #arrayOfStrings(), except that when there are values they are resolved to\nabsolute paths based on the current working directory" ], "signature": [ "(key: string) => string[] | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.arrayOfPaths.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredArrayOfPaths", "type": "Function", "tags": [], "label": "requiredArrayOfPaths", "description": [ "\nSame as #requiredArrayOfStrings(), except that values are resolved to absolute paths\nbased on the current working directory" ], "signature": [ "(key: string) => string[]" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredArrayOfPaths.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.number", "type": "Function", "tags": [], "label": "number", "description": [ "\nParsed the provided flag as a number, if the value does not parse to a valid number\nusing Number.parseFloat() then a \"flag error\" is thrown. If the flag is not passed\nundefined is returned." ], "signature": [ "(key: string) => number | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.number.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredNumber", "type": "Function", "tags": [], "label": "requiredNumber", "description": [ "\nSame as #number() except that when the flag is missing a \"flag error\" is thrown" ], "signature": [ "(key: string) => number" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.requiredNumber.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.boolean", "type": "Function", "tags": [], "label": "boolean", "description": [ "\nRead a boolean flag value, if the flag is properly defined as a \"boolean\" in the run options\nthen the value will always be a boolean, defaulting to `false`, so there is no need for an\noptional/requiredBoolean() method." ], "signature": [ "(key: string) => boolean" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.boolean.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.getPositionals", "type": "Function", "tags": [], "label": "getPositionals", "description": [ "\nGet the positional arguments passed, includes any values that are not associated with\na specific --flag" ], "signature": [ "() => string[]" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.getUnused", "type": "Function", "tags": [], "label": "getUnused", "description": [ "\nReturns all of the unused flags. When a flag is read via any of the key-specific methods\nthe key is marked as \"used\" and this method will return a map of just the flags which\nhave not been used yet (excluding the default flags like --debug, --verbose, and --help)" ], "signature": [ "() => Map" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagsReader.getUsed", "type": "Function", "tags": [], "label": "getUsed", "description": [ "\nReturns all of the used flags. When a flag is read via any of the key-specific methods\nthe key is marked as \"used\" and from then on this method will return a map including that\nand any other key used by these methods." ], "signature": [ "() => Map" ], "path": "packages/kbn-dev-cli-runner/src/flags_reader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommands", "type": "Class", "tags": [], "label": "RunWithCommands", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunWithCommands", "text": "RunWithCommands" }, "" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommands.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommands.Unnamed.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunWithCommandsOptions", "text": "RunWithCommandsOptions" }, "" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommands.Unnamed.$2", "type": "Array", "tags": [], "label": "commands", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.Command", "text": "Command" }, "[]" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommands.command", "type": "Function", "tags": [], "label": "command", "description": [], "signature": [ "(options: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.Command", "text": "Command" }, ") => ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunWithCommands", "text": "RunWithCommands" }, "" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommands.command.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.Command", "text": "Command" }, "" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommands.execute", "type": "Function", "tags": [], "label": "execute", "description": [], "signature": [ "() => Promise" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.getFlags", "type": "Function", "tags": [], "label": "getFlags", "description": [], "signature": [ "(argv: string[], flagOptions: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" }, " | undefined, defaultLogLevel: string) => ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.Flags", "text": "Flags" } ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.getFlags.$1", "type": "Array", "tags": [], "label": "argv", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.getFlags.$2", "type": "Object", "tags": [], "label": "flagOptions", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" }, " | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.getFlags.$3", "type": "string", "tags": [], "label": "defaultLogLevel", "description": [], "signature": [ "string" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.mergeFlagOptions", "type": "Function", "tags": [], "label": "mergeFlagOptions", "description": [], "signature": [ "(global: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" }, ", local: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" }, ") => ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" } ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.mergeFlagOptions.$1", "type": "Object", "tags": [], "label": "global", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" } ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.mergeFlagOptions.$2", "type": "Object", "tags": [], "label": "local", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" } ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.run", "type": "Function", "tags": [], "label": "run", "description": [], "signature": [ "(fn: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunFn", "text": "RunFn" }, ", options: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunOptions", "text": "RunOptions" }, ") => Promise" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.run.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunFn", "text": "RunFn" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.run.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunOptions", "text": "RunOptions" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Command", "type": "Interface", "tags": [], "label": "Command", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.Command", "text": "Command" }, "" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Command.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Command.run", "type": "Function", "tags": [], "label": "run", "description": [], "signature": [ "(context: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" }, " & T) => void | Promise" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Command.run.$1", "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" }, " & T" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Command.description", "type": "string", "tags": [], "label": "description", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Command.usage", "type": "string", "tags": [], "label": "usage", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Command.flags", "type": "Object", "tags": [], "label": "flags", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" }, " | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions", "type": "Interface", "tags": [], "label": "FlagOptions", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions.allowUnexpected", "type": "CompoundType", "tags": [], "label": "allowUnexpected", "description": [], "signature": [ "boolean | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions.guessTypesForUnexpectedFlags", "type": "CompoundType", "tags": [], "label": "guessTypesForUnexpectedFlags", "description": [], "signature": [ "boolean | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions.help", "type": "string", "tags": [], "label": "help", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions.alias", "type": "Object", "tags": [], "label": "alias", "description": [], "signature": [ "{ [key: string]: string | string[]; } | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions.boolean", "type": "Array", "tags": [], "label": "boolean", "description": [], "signature": [ "string[] | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions.string", "type": "Array", "tags": [], "label": "string", "description": [], "signature": [ "string[] | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.FlagOptions.default", "type": "Object", "tags": [], "label": "default", "description": [], "signature": [ "{ [key: string]: any; } | undefined" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags", "type": "Interface", "tags": [], "label": "Flags", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags.verbose", "type": "boolean", "tags": [], "label": "verbose", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags.quiet", "type": "boolean", "tags": [], "label": "quiet", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags.silent", "type": "boolean", "tags": [], "label": "silent", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags.debug", "type": "boolean", "tags": [], "label": "debug", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags.help", "type": "boolean", "tags": [], "label": "help", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags._", "type": "Array", "tags": [], "label": "_", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.Flags.unexpected", "type": "Array", "tags": [], "label": "unexpected", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "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-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext", "type": "Interface", "tags": [], "label": "RunContext", "description": [], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext.log", "type": "Object", "tags": [], "label": "log", "description": [], "signature": [ { "pluginId": "@kbn/tooling-log", "scope": "server", "docId": "kibKbnToolingLogPluginApi", "section": "def-server.ToolingLog", "text": "ToolingLog" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext.flags", "type": "Object", "tags": [], "label": "flags", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.Flags", "text": "Flags" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext.procRunner", "type": "Object", "tags": [], "label": "procRunner", "description": [], "signature": [ { "pluginId": "@kbn/dev-proc-runner", "scope": "server", "docId": "kibKbnDevProcRunnerPluginApi", "section": "def-server.ProcRunner", "text": "ProcRunner" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext.statsMeta", "type": "Object", "tags": [], "label": "statsMeta", "description": [], "signature": [ "Map" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext.addCleanupTask", "type": "Function", "tags": [], "label": "addCleanupTask", "description": [], "signature": [ "(task: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.CleanupTask", "text": "CleanupTask" }, ") => void" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext.addCleanupTask.$1", "type": "Function", "tags": [], "label": "task", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.CleanupTask", "text": "CleanupTask" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunContext.flagsReader", "type": "Object", "tags": [], "label": "flagsReader", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagsReader", "text": "FlagsReader" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunOptions", "type": "Interface", "tags": [], "label": "RunOptions", "description": [], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunOptions.usage", "type": "string", "tags": [], "label": "usage", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunOptions.description", "type": "string", "tags": [], "label": "description", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunOptions.log", "type": "Object", "tags": [], "label": "log", "description": [], "signature": [ "{ defaultLevel?: \"error\" | \"warning\" | \"success\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunOptions.flags", "type": "Object", "tags": [], "label": "flags", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" }, " | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommandsOptions", "type": "Interface", "tags": [], "label": "RunWithCommandsOptions", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunWithCommandsOptions", "text": "RunWithCommandsOptions" }, "" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommandsOptions.log", "type": "Object", "tags": [], "label": "log", "description": [], "signature": [ "{ defaultLevel?: \"error\" | \"warning\" | \"success\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommandsOptions.description", "type": "string", "tags": [], "label": "description", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommandsOptions.usage", "type": "string", "tags": [], "label": "usage", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommandsOptions.globalFlags", "type": "Object", "tags": [], "label": "globalFlags", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.FlagOptions", "text": "FlagOptions" }, " | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommandsOptions.extendContext", "type": "Function", "tags": [], "label": "extendContext", "description": [], "signature": [ "((context: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" }, ") => T | Promise) | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunWithCommandsOptions.extendContext.$1", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" } ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/dev-cli-runner", "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-cli-runner/src/cleanup.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.CommandRunFn", "type": "Type", "tags": [], "label": "CommandRunFn", "description": [], "signature": [ "(context: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" }, " & T) => void | Promise" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.CommandRunFn.$1", "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" }, " & T" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunFn", "type": "Type", "tags": [], "label": "RunFn", "description": [], "signature": [ "(context: ", { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" }, ") => void | Promise" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.RunFn.$1", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/dev-cli-runner", "scope": "server", "docId": "kibKbnDevCliRunnerPluginApi", "section": "def-server.RunContext", "text": "RunContext" } ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "objects": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.DEFAULT_FLAG_ALIASES", "type": "Object", "tags": [], "label": "DEFAULT_FLAG_ALIASES", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dev-cli-runner", "id": "def-server.DEFAULT_FLAG_ALIASES.v", "type": "string", "tags": [], "label": "v", "description": [], "path": "packages/kbn-dev-cli-runner/src/flags.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }