maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/kbn_config_schema.json
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564) 
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

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

3495 lines
115 KiB
JSON
Raw Blame History

{
"id": "@kbn/config-schema",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue",
"type": "Class",
"tags": [],
"label": "ByteSizeValue",
"description": [],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.parse",
"type": "Function",
"tags": [],
"label": "parse",
"description": [],
"signature": [
"(text: string) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
}
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.parse.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.Unnamed.$1",
"type": "number",
"tags": [],
"label": "valueInBytes",
"description": [],
"signature": [
"number"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.isGreaterThan",
"type": "Function",
"tags": [],
"label": "isGreaterThan",
"description": [],
"signature": [
"(other: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
},
") => boolean"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.isGreaterThan.$1",
"type": "Object",
"tags": [],
"label": "other",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
}
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.isLessThan",
"type": "Function",
"tags": [],
"label": "isLessThan",
"description": [],
"signature": [
"(other: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
},
") => boolean"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.isLessThan.$1",
"type": "Object",
"tags": [],
"label": "other",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
}
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.isEqualTo",
"type": "Function",
"tags": [],
"label": "isEqualTo",
"description": [],
"signature": [
"(other: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
},
") => boolean"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.isEqualTo.$1",
"type": "Object",
"tags": [],
"label": "other",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
}
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.getValueInBytes",
"type": "Function",
"tags": [],
"label": "getValueInBytes",
"description": [],
"signature": [
"() => number"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.toString",
"type": "Function",
"tags": [],
"label": "toString",
"description": [],
"signature": [
"(returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ByteSizeValue.toString.$1",
"type": "CompoundType",
"tags": [],
"label": "returnUnit",
"description": [],
"signature": [
"\"b\" | \"kb\" | \"mb\" | \"gb\" | undefined"
],
"path": "packages/kbn-config-schema/src/byte_size_value/index.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType",
"type": "Class",
"tags": [],
"label": "ObjectType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ObjectType",
"text": "ObjectType"
},
"<P> extends ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Readonly<{ [K in keyof Pick<P, { [Key in keyof P]: undefined extends ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.TypeOf",
"text": "TypeOf"
},
"<P[Key]> ? Key : never; }[keyof P]>]?: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.TypeOf",
"text": "TypeOf"
},
"<P[K]> | undefined; } & { [K in keyof Pick<P, { [Key in keyof P]: undefined extends ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.TypeOf",
"text": "TypeOf"
},
"<P[Key]> ? never : Key; }[keyof P]>]: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.TypeOf",
"text": "TypeOf"
},
"<P[K]>; }>>"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.Unnamed.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.Unnamed.$2",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ObjectTypeOptions",
"<P>"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.extends",
"type": "Function",
"tags": [],
"label": "extends",
"description": [
"\nReturn a new `ObjectType` instance extended with given `newProps` properties.\nOriginal properties can be deleted from the copy by passing a `null` or `undefined` value for the key.\n"
],
"signature": [
"<NP extends Record<string, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<any> | null | undefined>>(newProps: NP, newOptions?: ",
"ObjectTypeOptions",
"<ExtendedProps<P, NP>> | undefined) => ExtendedObjectType<P, NP>"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.extends.$1",
"type": "Uncategorized",
"tags": [],
"label": "newProps",
"description": [],
"signature": [
"NP"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.extends.$2",
"type": "CompoundType",
"tags": [],
"label": "newOptions",
"description": [],
"signature": [
"ObjectTypeOptions",
"<ExtendedProps<P, NP>> | undefined"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.handleError",
"type": "Function",
"tags": [],
"label": "handleError",
"description": [],
"signature": [
"(type: string, { reason, value }: Record<string, any>) => any"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.handleError.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.handleError.$2",
"type": "Object",
"tags": [],
"label": "{ reason, value }",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.validateKey",
"type": "Function",
"tags": [],
"label": "validateKey",
"description": [],
"signature": [
"(key: string, value: any) => any"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.validateKey.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ObjectType.validateKey.$2",
"type": "Any",
"tags": [],
"label": "value",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.SchemaTypeError",
"type": "Class",
"tags": [],
"label": "SchemaTypeError",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.SchemaTypeError",
"text": "SchemaTypeError"
},
" extends ",
"SchemaError"
],
"path": "packages/kbn-config-schema/src/errors/schema_type_error.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.SchemaTypeError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/errors/schema_type_error.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.SchemaTypeError.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"string | Error"
],
"path": "packages/kbn-config-schema/src/errors/schema_type_error.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.SchemaTypeError.Unnamed.$2",
"type": "Array",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-config-schema/src/errors/schema_type_error.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type",
"type": "Class",
"tags": [],
"label": "Type",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.type",
"type": "Uncategorized",
"tags": [],
"label": "type",
"description": [],
"signature": [
"V"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.__isKbnConfigSchemaType",
"type": "boolean",
"tags": [],
"label": "__isKbnConfigSchemaType",
"description": [],
"signature": [
"true"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.internalSchema",
"type": "Object",
"tags": [
"type"
],
"label": "internalSchema",
"description": [
"\nInternal \"schema\" backed by Joi."
],
"signature": [
"AnySchema"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "schema",
"description": [],
"signature": [
"AnySchema"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"TypeOptions",
"<V>"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"(value: any, context?: Record<string, any>, namespace?: string | undefined) => V"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.validate.$1",
"type": "Any",
"tags": [],
"label": "value",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.validate.$2",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.validate.$3",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.handleError",
"type": "Function",
"tags": [],
"label": "handleError",
"description": [],
"signature": [
"(type: string, context: Record<string, any>, path: string[]) => string | void | ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.SchemaTypeError",
"text": "SchemaTypeError"
}
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.handleError.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.handleError.$2",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Type.handleError.$3",
"type": "Array",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-config-schema/src/types/type.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ValidationError",
"type": "Class",
"tags": [],
"label": "ValidationError",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ValidationError",
"text": "ValidationError"
},
" extends ",
"SchemaError"
],
"path": "packages/kbn-config-schema/src/errors/validation_error.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ValidationError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/errors/validation_error.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ValidationError.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.SchemaTypeError",
"text": "SchemaTypeError"
}
],
"path": "packages/kbn-config-schema/src/errors/validation_error.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.ValidationError.Unnamed.$2",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-config-schema/src/errors/validation_error.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.isConfigSchema",
"type": "Function",
"tags": [],
"label": "isConfigSchema",
"description": [],
"signature": [
"(obj: any) => boolean"
],
"path": "packages/kbn-config-schema/src/typeguards/is_config_schema.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.isConfigSchema.$1",
"type": "Any",
"tags": [],
"label": "obj",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-config-schema/src/typeguards/is_config_schema.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.NullableProps",
"type": "Type",
"tags": [],
"label": "NullableProps",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<any> | null | undefined; }"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Props",
"type": "Type",
"tags": [],
"label": "Props",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<any>; }"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.Schema",
"type": "Type",
"tags": [],
"label": "Schema",
"description": [],
"signature": [
"{ any: (options?: ",
"TypeOptions",
"<any> | undefined) => ",
"AnyType",
"; arrayOf: <T>(itemType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<T>, options?: ",
"ArrayOptions",
"<T> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<T[]>; boolean: (options?: ",
"TypeOptions",
"<boolean> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<boolean>; buffer: (options?: ",
"TypeOptions",
"<Buffer> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Buffer>; byteSize: (options?: ",
"ByteSizeOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
},
">; conditional: <A extends ",
"ConditionalTypeValue",
", B, C>(leftOperand: ",
"Reference",
"<A>, rightOperand: A | ",
"Reference",
"<A> | ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<unknown>, equalType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, notEqualType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, options?: ",
"TypeOptions",
"<B | C> | undefined) => ",
"ConditionalType",
"<A, B, C>; contextRef: <T>(key: string) => ",
"ContextReference",
"<T>; duration: (options?: ",
"DurationOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<moment.Duration>; ip: (options?: ",
"IpOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string>; literal: <T extends string | number | boolean | null>(value: T) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<T>; mapOf: <K, V>(keyType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<K>, valueType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>, options?: ",
"MapOfOptions",
"<K, V> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Map<K, V>>; maybe: <V>(type: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V | undefined>; nullable: <V>(type: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V | null>; never: () => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<never>; number: (options?: ",
"NumberOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<number>; object: <P extends Record<string, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<any>>>(props: P, options?: ",
"ObjectTypeOptions",
"<P> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ObjectType",
"text": "ObjectType"
},
"<P>; oneOf: { <A, B, C, D, E, F, G, H, I, J>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<H>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<I>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<J>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G | H | I | J> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G | H | I | J>; <A, B, C, D, E, F, G, H, I>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<H>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<I>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G | H | I> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G | H | I>; <A, B, C, D, E, F, G, H>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<H>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G | H> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G | H>; <A, B, C, D, E, F, G>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G>; <A, B, C, D, E, F>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F>; <A, B, C, D, E>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>], options?: ",
"TypeOptions",
"<A | B | C | D | E> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E>; <A, B, C, D>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>], options?: ",
"TypeOptions",
"<A | B | C | D> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D>; <A, B, C>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>], options?: ",
"TypeOptions",
"<A | B | C> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C>; <A, B>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>], options?: ",
"TypeOptions",
"<A | B> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B>; <A>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>], options?: ",
"TypeOptions",
"<A> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>; }; recordOf: <K extends string, V>(keyType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<K>, valueType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>, options?: ",
"RecordOfOptions",
"<K, V> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Record<K, V>>; stream: (options?: ",
"TypeOptions",
"<",
"Stream",
"> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<",
"Stream",
">; siblingRef: <T>(key: string) => ",
"SiblingReference",
"<T>; string: (options?: ",
"StringOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string>; uri: (options?: ",
"URIOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string>; }"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.TypeOf",
"type": "Type",
"tags": [],
"label": "TypeOf",
"description": [],
"signature": [
"RT[\"type\"]"
],
"path": "packages/kbn-config-schema/src/types/object_type.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema",
"type": "Object",
"tags": [],
"label": "schema",
"description": [],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.any",
"type": "Function",
"tags": [],
"label": "any",
"description": [],
"signature": [
"(options?: ",
"TypeOptions",
"<any> | undefined) => ",
"AnyType"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.any.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"TypeOptions",
"<any> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.arrayOf",
"type": "Function",
"tags": [],
"label": "arrayOf",
"description": [],
"signature": [
"<T>(itemType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<T>, options?: ",
"ArrayOptions",
"<T> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<T[]>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.arrayOf.$1",
"type": "Object",
"tags": [],
"label": "itemType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.arrayOf.$2",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ArrayOptions",
"<T> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.boolean",
"type": "Function",
"tags": [],
"label": "boolean",
"description": [],
"signature": [
"(options?: ",
"TypeOptions",
"<boolean> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<boolean>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.boolean.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"TypeOptions",
"<boolean> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.buffer",
"type": "Function",
"tags": [],
"label": "buffer",
"description": [],
"signature": [
"(options?: ",
"TypeOptions",
"<Buffer> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Buffer>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.buffer.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"TypeOptions",
"<Buffer> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.byteSize",
"type": "Function",
"tags": [],
"label": "byteSize",
"description": [],
"signature": [
"(options?: ",
"ByteSizeOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ByteSizeValue",
"text": "ByteSizeValue"
},
">"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.byteSize.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ByteSizeOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.conditional",
"type": "Function",
"tags": [],
"label": "conditional",
"description": [],
"signature": [
"<A extends ",
"ConditionalTypeValue",
", B, C>(leftOperand: ",
"Reference",
"<A>, rightOperand: A | ",
"Reference",
"<A> | ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<unknown>, equalType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, notEqualType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, options?: ",
"TypeOptions",
"<B | C> | undefined) => ",
"ConditionalType",
"<A, B, C>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.conditional.$1",
"type": "Object",
"tags": [],
"label": "leftOperand",
"description": [],
"signature": [
"Reference",
"<A>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.conditional.$2",
"type": "CompoundType",
"tags": [],
"label": "rightOperand",
"description": [],
"signature": [
"A | ",
"Reference",
"<A> | ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<unknown>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.conditional.$3",
"type": "Object",
"tags": [],
"label": "equalType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.conditional.$4",
"type": "Object",
"tags": [],
"label": "notEqualType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.conditional.$5",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"TypeOptions",
"<B | C> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.contextRef",
"type": "Function",
"tags": [],
"label": "contextRef",
"description": [],
"signature": [
"<T>(key: string) => ",
"ContextReference",
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.contextRef.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.duration",
"type": "Function",
"tags": [],
"label": "duration",
"description": [],
"signature": [
"(options?: ",
"DurationOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<moment.Duration>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.duration.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"DurationOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.ip",
"type": "Function",
"tags": [],
"label": "ip",
"description": [],
"signature": [
"(options?: ",
"IpOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.ip.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"IpOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.literal",
"type": "Function",
"tags": [],
"label": "literal",
"description": [],
"signature": [
"<T extends string | number | boolean | null>(value: T) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.literal.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.mapOf",
"type": "Function",
"tags": [],
"label": "mapOf",
"description": [],
"signature": [
"<K, V>(keyType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<K>, valueType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>, options?: ",
"MapOfOptions",
"<K, V> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Map<K, V>>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.mapOf.$1",
"type": "Object",
"tags": [],
"label": "keyType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<K>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.mapOf.$2",
"type": "Object",
"tags": [],
"label": "valueType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.mapOf.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"MapOfOptions",
"<K, V> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.maybe",
"type": "Function",
"tags": [],
"label": "maybe",
"description": [],
"signature": [
"<V>(type: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V | undefined>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.maybe.$1",
"type": "Object",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.nullable",
"type": "Function",
"tags": [],
"label": "nullable",
"description": [],
"signature": [
"<V>(type: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V | null>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.nullable.$1",
"type": "Object",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.never",
"type": "Function",
"tags": [],
"label": "never",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<never>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.number",
"type": "Function",
"tags": [],
"label": "number",
"description": [],
"signature": [
"(options?: ",
"NumberOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<number>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.number.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"NumberOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.object",
"type": "Function",
"tags": [],
"label": "object",
"description": [],
"signature": [
"<P extends Record<string, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<any>>>(props: P, options?: ",
"ObjectTypeOptions",
"<P> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ObjectType",
"text": "ObjectType"
},
"<P>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.object.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.object.$2",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ObjectTypeOptions",
"<P> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.oneOf",
"type": "Function",
"tags": [],
"label": "oneOf",
"description": [],
"signature": [
"{ <A, B, C, D, E, F, G, H, I, J>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<H>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<I>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<J>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G | H | I | J> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G | H | I | J>; <A, B, C, D, E, F, G, H, I>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<H>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<I>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G | H | I> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G | H | I>; <A, B, C, D, E, F, G, H>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<H>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G | H> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G | H>; <A, B, C, D, E, F, G>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<G>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F | G> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F | G>; <A, B, C, D, E, F>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<F>], options?: ",
"TypeOptions",
"<A | B | C | D | E | F> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E | F>; <A, B, C, D, E>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<E>], options?: ",
"TypeOptions",
"<A | B | C | D | E> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D | E>; <A, B, C, D>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<D>], options?: ",
"TypeOptions",
"<A | B | C | D> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C | D>; <A, B, C>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<C>], options?: ",
"TypeOptions",
"<A | B | C> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B | C>; <A, B>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>, ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<B>], options?: ",
"TypeOptions",
"<A | B> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A | B>; <A>(types: [",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>], options?: ",
"TypeOptions",
"<A> | undefined): ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<A>; }"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.recordOf",
"type": "Function",
"tags": [],
"label": "recordOf",
"description": [],
"signature": [
"<K extends string, V>(keyType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<K>, valueType: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>, options?: ",
"RecordOfOptions",
"<K, V> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Record<K, V>>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.recordOf.$1",
"type": "Object",
"tags": [],
"label": "keyType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<K>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.recordOf.$2",
"type": "Object",
"tags": [],
"label": "valueType",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.recordOf.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"RecordOfOptions",
"<K, V> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.stream",
"type": "Function",
"tags": [],
"label": "stream",
"description": [],
"signature": [
"(options?: ",
"TypeOptions",
"<",
"Stream",
"> | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<",
"Stream",
">"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.stream.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"TypeOptions",
"<",
"Stream",
"> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.siblingRef",
"type": "Function",
"tags": [],
"label": "siblingRef",
"description": [],
"signature": [
"<T>(key: string) => ",
"SiblingReference",
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.siblingRef.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.string",
"type": "Function",
"tags": [],
"label": "string",
"description": [],
"signature": [
"(options?: ",
"StringOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.string.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"StringOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.uri",
"type": "Function",
"tags": [],
"label": "uri",
"description": [],
"signature": [
"(options?: ",
"URIOptions",
" | undefined) => ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/config-schema",
"id": "def-server.schema.uri.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"URIOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"deprecated": false
}
]
}
],
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink