2021-10-06 23:02:57 +02:00
{
"id" : "@kbn/config" ,
"client" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"server" : {
"classes" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.Env" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "Env" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/env.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.Env.packageInfo" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "packageInfo" ,
"description" : [
"\nInformation about Kibana package (version, build number etc.)."
] ,
"signature" : [
"{ readonly version: string; readonly branch: string; readonly buildNum: number; readonly buildSha: string; readonly dist: boolean; }"
] ,
"path" : "packages/kbn-config/src/env.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.Env.mode" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "mode" ,
"description" : [
"\nMode Kibana currently run in (development or production)."
] ,
"signature" : [
"{ readonly name: \"production\" | \"development\"; readonly dev: boolean; readonly prod: boolean; }"
] ,
"path" : "packages/kbn-config/src/env.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
}
] ,
"functions" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.getPluginSearchPaths" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getPluginSearchPaths" ,
"description" : [ ] ,
"signature" : [
"({ rootDir, oss, examples }: SearchOptions) => string[]"
] ,
"path" : "packages/kbn-config/src/plugins/plugin_search_paths.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.getPluginSearchPaths.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{ rootDir, oss, examples }" ,
"description" : [ ] ,
"signature" : [
"SearchOptions"
] ,
"path" : "packages/kbn-config/src/plugins/plugin_search_paths.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.hasConfigPathIntersection" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "hasConfigPathIntersection" ,
"description" : [ ] ,
"signature" : [
"(leafPath: string, rootPath: string) => boolean"
] ,
"path" : "packages/kbn-config/src/config.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.hasConfigPathIntersection.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "leafPath" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/config.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.hasConfigPathIntersection.$2" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "rootPath" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/config.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.isConfigPath" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "isConfigPath" ,
"description" : [
"\nChecks whether specified value can be considered as config path."
] ,
"signature" : [
"(value: unknown) => boolean"
] ,
"path" : "packages/kbn-config/src/config.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.isConfigPath.$1" ,
"type" : "Unknown" ,
"tags" : [ ] ,
"label" : "value" ,
"description" : [
"Value to check."
] ,
"signature" : [
"unknown"
] ,
"path" : "packages/kbn-config/src/config.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ChangedDeprecatedPaths" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "ChangedDeprecatedPaths" ,
"description" : [
"\nList of config paths changed during deprecation.\n"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ChangedDeprecatedPaths.set" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "set" ,
"description" : [ ] ,
"signature" : [
"string[]"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ChangedDeprecatedPaths.unset" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "unset" ,
"description" : [ ] ,
"signature" : [
"string[]"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationCommand" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "ConfigDeprecationCommand" ,
"description" : [
"\nOutcome of deprecation operation. Allows mutating config values in a declarative way.\n"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationCommand.set" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "set" ,
"description" : [ ] ,
"signature" : [
"{ path: string; value: any; }[] | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationCommand.unset" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "unset" ,
"description" : [ ] ,
"signature" : [
"{ path: string; }[] | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-10-12 01:46:01 +02:00
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationContext" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "ConfigDeprecationContext" ,
"description" : [
"\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\n"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationContext.version" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "version" ,
"description" : [
"The current Kibana version, e.g `7.16.1`, `8.0.0`"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationContext.branch" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "branch" ,
"description" : [
"The current Kibana branch, e.g `7.x`, `7.16`, `master`"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-10-06 23:02:57 +02:00
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "ConfigDeprecationFactory" ,
"description" : [
"\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecate" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "deprecate" ,
"description" : [
"\nDeprecate a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the deprecatedKey was found.\n"
] ,
"signature" : [
"(deprecatedKey: string, removeBy: string, details?: Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined) => " ,
2021-10-12 01:46:01 +02:00
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecation" ,
"text" : "ConfigDeprecation"
}
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecate.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "deprecatedKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecate.$2" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "removeBy" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecate.$3" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecateFromRoot" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "deprecateFromRoot" ,
"description" : [
"\nDeprecate a configuration property from the root configuration.\nWill log a deprecation warning if the deprecatedKey was found.\n\nThis should be only used when deprecating properties from different configuration's path.\nTo deprecate properties from inside a plugin's configuration, use 'deprecate' instead.\n"
] ,
"signature" : [
"(deprecatedKey: string, removeBy: string, details?: Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined) => " ,
2021-10-12 01:46:01 +02:00
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecation" ,
"text" : "ConfigDeprecation"
}
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecateFromRoot.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "deprecatedKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecateFromRoot.$2" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "removeBy" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.deprecateFromRoot.$3" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.rename" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "rename" ,
"description" : [
"\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n"
] ,
"signature" : [
"(oldKey: string, newKey: string, details?: Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined) => " ,
2021-10-12 01:46:01 +02:00
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecation" ,
"text" : "ConfigDeprecation"
}
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.rename.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "oldKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.rename.$2" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "newKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.rename.$3" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.renameFromRoot" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "renameFromRoot" ,
"description" : [
"\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n"
] ,
"signature" : [
"(oldKey: string, newKey: string, details?: Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined) => " ,
2021-10-12 01:46:01 +02:00
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecation" ,
"text" : "ConfigDeprecation"
}
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.renameFromRoot.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "oldKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.renameFromRoot.$2" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "newKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.renameFromRoot.$3" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.unused" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "unused" ,
"description" : [
"\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n"
] ,
"signature" : [
"(unusedKey: string, details?: Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined) => " ,
2021-10-12 01:46:01 +02:00
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecation" ,
"text" : "ConfigDeprecation"
}
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.unused.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "unusedKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.unused.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.unusedFromRoot" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "unusedFromRoot" ,
"description" : [
"\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n"
] ,
"signature" : [
"(unusedKey: string, details?: Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined) => " ,
2021-10-12 01:46:01 +02:00
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecation" ,
"text" : "ConfigDeprecation"
}
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.unusedFromRoot.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "unusedKey" ,
"description" : [ ] ,
"signature" : [
"string"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationFactory.unusedFromRoot.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"Partial<" ,
"DeprecatedConfigDetails" ,
"> | undefined"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.EnvironmentMode" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "EnvironmentMode" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.EnvironmentMode.name" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "name" ,
"description" : [ ] ,
"signature" : [
"\"production\" | \"development\""
] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.EnvironmentMode.dev" ,
"type" : "boolean" ,
"tags" : [ ] ,
"label" : "dev" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.EnvironmentMode.prod" ,
"type" : "boolean" ,
"tags" : [ ] ,
"label" : "prod" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.PackageInfo" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "PackageInfo" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.PackageInfo.version" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "version" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.PackageInfo.branch" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "branch" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.PackageInfo.buildNum" ,
"type" : "number" ,
"tags" : [ ] ,
"label" : "buildNum" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.PackageInfo.buildSha" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "buildSha" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.PackageInfo.dist" ,
"type" : "boolean" ,
"tags" : [ ] ,
"label" : "dist" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.AddConfigDeprecation" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "AddConfigDeprecation" ,
"description" : [
"\nConfig deprecation hook used when invoking a {@link ConfigDeprecation}\n"
] ,
"signature" : [
"(details: " ,
"DeprecatedConfigDetails" ,
") => void"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.AddConfigDeprecation.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"DeprecatedConfigDetails"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-10-12 01:46:01 +02:00
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecation" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ConfigDeprecation" ,
"description" : [
"\nConfiguration deprecation returned from {@link ConfigDeprecationProvider} that handles a single deprecation from the configuration.\n"
] ,
"signature" : [
"(config: Readonly<{ [x: string]: any; }>, fromPath: string, addDeprecation: " ,
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.AddConfigDeprecation" ,
"text" : "AddConfigDeprecation"
} ,
", context: " ,
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecationContext" ,
"text" : "ConfigDeprecationContext"
} ,
") => void | " ,
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecationCommand" ,
"text" : "ConfigDeprecationCommand"
}
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecation.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "config" ,
"description" : [
"must not be mutated, return {@link ConfigDeprecationCommand} to change config shape."
] ,
"signature" : [
"{ readonly [x: string]: any; }"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecation.$2" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "fromPath" ,
"description" : [ ] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecation.$3" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "addDeprecation" ,
"description" : [ ] ,
"signature" : [
"(details: " ,
"DeprecatedConfigDetails" ,
") => void"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecation.$3.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "details" ,
"description" : [ ] ,
"signature" : [
"DeprecatedConfigDetails"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
}
]
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecation.$4" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "context" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecationContext" ,
"text" : "ConfigDeprecationContext"
}
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-10-06 23:02:57 +02:00
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationProvider" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ConfigDeprecationProvider" ,
"description" : [
"\nA provider that should returns a list of {@link ConfigDeprecation}.\n\nSee {@link ConfigDeprecationFactory} for more usage examples.\n"
] ,
"signature" : [
"(factory: " ,
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecationFactory" ,
"text" : "ConfigDeprecationFactory"
} ,
") => " ,
2021-10-12 01:46:01 +02:00
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecation" ,
"text" : "ConfigDeprecation"
} ,
2021-10-06 23:02:57 +02:00
"[]"
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigDeprecationProvider.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "factory" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/config" ,
"scope" : "server" ,
"docId" : "kibKbnConfigPluginApi" ,
"section" : "def-server.ConfigDeprecationFactory" ,
"text" : "ConfigDeprecationFactory"
}
] ,
"path" : "packages/kbn-config/src/deprecation/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.ConfigPath" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ConfigPath" ,
"description" : [ ] ,
"signature" : [
"string | string[]"
] ,
"path" : "packages/kbn-config/src/config.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.RawConfigAdapter" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "RawConfigAdapter" ,
"description" : [ ] ,
"signature" : [
"(rawConfig: Record<string, any>) => Record<string, any>"
] ,
"path" : "packages/kbn-config/src/raw/raw_config_service.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.RawConfigAdapter.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "rawConfig" ,
"description" : [ ] ,
"signature" : [
"{ [x: string]: any; }"
] ,
"path" : "packages/kbn-config/src/raw/raw_config_service.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/config" ,
"id" : "def-server.RawConfigurationProvider" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "RawConfigurationProvider" ,
"description" : [ ] ,
"signature" : [
"{ getConfig$: () => " ,
"Observable" ,
"<Record<string, any>>; }"
] ,
"path" : "packages/kbn-config/src/raw/raw_config_service.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
}
] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}