{ "id": "@kbn/config-schema", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.AnyType", "type": "Class", "tags": [], "label": "AnyType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.AnyType", "text": "AnyType" }, " extends ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/src/types/any_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.AnyType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/types/any_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.AnyType.Unnamed.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", " | undefined" ], "path": "packages/kbn-config-schema/src/types/any_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.AnyType.handleError", "type": "Function", "tags": [], "label": "handleError", "description": [], "signature": [ "(type: string, { value }: Record) => string | undefined" ], "path": "packages/kbn-config-schema/src/types/any_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.AnyType.handleError.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "packages/kbn-config-schema/src/types/any_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.AnyType.handleError.$2", "type": "Object", "tags": [], "label": "{ value }", "description": [], "signature": [ "Record" ], "path": "packages/kbn-config-schema/src/types/any_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue", "type": "Class", "tags": [], "label": "ByteSizeValue", "description": [], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.parse", "type": "Function", "tags": [], "label": "parse", "description": [], "signature": [ "(text: string) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" } ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.parse.$1", "type": "string", "tags": [], "label": "text", "description": [], "signature": [ "string" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.Unnamed.$1", "type": "number", "tags": [], "label": "valueInBytes", "description": [], "signature": [ "number" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.isGreaterThan", "type": "Function", "tags": [], "label": "isGreaterThan", "description": [], "signature": [ "(other: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" }, ") => boolean" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.isGreaterThan.$1", "type": "Object", "tags": [], "label": "other", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" } ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.isLessThan", "type": "Function", "tags": [], "label": "isLessThan", "description": [], "signature": [ "(other: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" }, ") => boolean" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.isLessThan.$1", "type": "Object", "tags": [], "label": "other", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" } ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.isEqualTo", "type": "Function", "tags": [], "label": "isEqualTo", "description": [], "signature": [ "(other: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" }, ") => boolean" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.isEqualTo.$1", "type": "Object", "tags": [], "label": "other", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" } ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.getValueInBytes", "type": "Function", "tags": [], "label": "getValueInBytes", "description": [], "signature": [ "() => number" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.toString", "type": "Function", "tags": [], "label": "toString", "description": [], "signature": [ "(returnUnit?: ", "ByteSizeValueUnit", " | undefined) => string" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ByteSizeValue.toString.$1", "type": "CompoundType", "tags": [], "label": "returnUnit", "description": [], "signature": [ "ByteSizeValueUnit", " | undefined" ], "path": "packages/kbn-config-schema/src/byte_size_value/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType", "type": "Class", "tags": [], "label": "ConditionalType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ConditionalType", "text": "ConditionalType" }, " extends ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.Unnamed.$1", "type": "Object", "tags": [], "label": "leftOperand", "description": [], "signature": [ "Reference", "" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "rightOperand", "description": [], "signature": [ "A | ", "Reference", " | ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.Unnamed.$3", "type": "Object", "tags": [], "label": "equalType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.Unnamed.$4", "type": "Object", "tags": [], "label": "notEqualType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.Unnamed.$5", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", " | undefined" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.extendsDeep", "type": "Function", "tags": [], "label": "extendsDeep", "description": [], "signature": [ "(options: ", "ExtendsDeepOptions", ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ConditionalType", "text": "ConditionalType" }, "" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.extendsDeep.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "ExtendsDeepOptions" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.handleError", "type": "Function", "tags": [], "label": "handleError", "description": [], "signature": [ "(type: string, { value }: Record) => string | undefined" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.handleError.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ConditionalType.handleError.$2", "type": "Object", "tags": [], "label": "{ value }", "description": [], "signature": [ "Record" ], "path": "packages/kbn-config-schema/src/types/conditional_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType", "type": "Class", "tags": [], "label": "ObjectType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ObjectType", "text": "ObjectType" }, "

extends ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "]?: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.TypeOf", "text": "TypeOf" }, " | undefined; } & { [K in keyof RequiredProperties

]: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.TypeOf", "text": "TypeOf" }, "; }>>" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.Unnamed.$1", "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ "P" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "ObjectTypeOptions", "

" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.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": [ "(newProps: NP, newOptions?: ExtendedObjectTypeOptions | undefined) => ExtendedObjectType" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.extends.$1", "type": "Uncategorized", "tags": [], "label": "newProps", "description": [], "signature": [ "NP" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.extends.$2", "type": "CompoundType", "tags": [], "label": "newOptions", "description": [], "signature": [ "ExtendedObjectTypeOptions | undefined" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.extendsDeep", "type": "Function", "tags": [], "label": "extendsDeep", "description": [], "signature": [ "(options: ", "ExtendsDeepOptions", ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ObjectType", "text": "ObjectType" }, "

(props: P, options?: ", "ObjectTypeOptions", "

| undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ObjectType", "text": "ObjectType" }, "

; oneOf: { (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; }; recordOf: (keyType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", valueType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "RecordOfOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ">; stream: (options?: ", "TypeOptions", "<", "Stream", "> | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "<", "Stream", ">; siblingRef: (key: string) => ", "SiblingReference", "; string: (options?: ", "StringOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; uri: (options?: ", "URIOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; }" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.TypeOf", "type": "Type", "tags": [], "label": "TypeOf", "description": [], "signature": [ "RT[\"type\"]" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema", "type": "Object", "tags": [], "label": "schema", "description": [], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.any", "type": "Function", "tags": [], "label": "any", "description": [], "signature": [ "(options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.AnyType", "text": "AnyType" } ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.any.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.arrayOf", "type": "Function", "tags": [], "label": "arrayOf", "description": [], "signature": [ "(itemType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "ArrayOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.arrayOf.$1", "type": "Object", "tags": [], "label": "itemType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.arrayOf.$2", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "ArrayOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.boolean", "type": "Function", "tags": [], "label": "boolean", "description": [], "signature": [ "(options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.boolean.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.buffer", "type": "Function", "tags": [], "label": "buffer", "description": [], "signature": [ "(options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.buffer.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.byteSize", "type": "Function", "tags": [], "label": "byteSize", "description": [], "signature": [ "(options?: ", "ByteSizeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "<", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" }, ">" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.byteSize.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "ByteSizeOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.conditional", "type": "Function", "tags": [], "label": "conditional", "description": [], "signature": [ "(leftOperand: ", "Reference", ", rightOperand: A | ", "Reference", " | ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", equalType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", notEqualType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ConditionalType", "text": "ConditionalType" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.conditional.$1", "type": "Object", "tags": [], "label": "leftOperand", "description": [], "signature": [ "Reference", "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.conditional.$2", "type": "CompoundType", "tags": [], "label": "rightOperand", "description": [], "signature": [ "A | ", "Reference", " | ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.conditional.$3", "type": "Object", "tags": [], "label": "equalType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.conditional.$4", "type": "Object", "tags": [], "label": "notEqualType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.conditional.$5", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.contextRef", "type": "Function", "tags": [], "label": "contextRef", "description": [], "signature": [ "(key: string) => ", "ContextReference", "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.contextRef.$1", "type": "string", "tags": [], "label": "key", "description": [], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.duration", "type": "Function", "tags": [], "label": "duration", "description": [], "signature": [ "(options?: ", "DurationOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.duration.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "DurationOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.ip", "type": "Function", "tags": [], "label": "ip", "description": [], "signature": [ "(options?: ", "IpOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.ip.$1", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "IpOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.literal", "type": "Function", "tags": [], "label": "literal", "description": [], "signature": [ "(value: T) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.literal.$1", "type": "Uncategorized", "tags": [], "label": "value", "description": [], "signature": [ "T" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.mapOf", "type": "Function", "tags": [], "label": "mapOf", "description": [], "signature": [ "(keyType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", valueType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "MapOfOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ">" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.mapOf.$1", "type": "Object", "tags": [], "label": "keyType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.mapOf.$2", "type": "Object", "tags": [], "label": "valueType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.mapOf.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "MapOfOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.maybe", "type": "Function", "tags": [], "label": "maybe", "description": [], "signature": [ "(type: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.maybe.$1", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.nullable", "type": "Function", "tags": [], "label": "nullable", "description": [], "signature": [ "(type: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.nullable.$1", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.never", "type": "Function", "tags": [], "label": "never", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.number", "type": "Function", "tags": [], "label": "number", "description": [], "signature": [ "(options?: ", "NumberOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.number.$1", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "NumberOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.object", "type": "Function", "tags": [], "label": "object", "description": [], "signature": [ "

(props: P, options?: ", "ObjectTypeOptions", "

| undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ObjectType", "text": "ObjectType" }, "

" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.object.$1", "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ "P" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.object.$2", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "ObjectTypeOptions", "

| undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.oneOf", "type": "Function", "tags": [], "label": "oneOf", "description": [], "signature": [ "{ (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; (types: [", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "], options?: ", "TypeOptions", " | undefined): ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; }" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.recordOf", "type": "Function", "tags": [], "label": "recordOf", "description": [], "signature": [ "(keyType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", valueType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "RecordOfOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ">" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.recordOf.$1", "type": "Object", "tags": [], "label": "keyType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.recordOf.$2", "type": "Object", "tags": [], "label": "valueType", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.recordOf.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "RecordOfOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.stream", "type": "Function", "tags": [], "label": "stream", "description": [], "signature": [ "(options?: ", "TypeOptions", "<", "Stream", "> | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "<", "Stream", ">" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.stream.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", "<", "Stream", "> | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.siblingRef", "type": "Function", "tags": [], "label": "siblingRef", "description": [], "signature": [ "(key: string) => ", "SiblingReference", "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.siblingRef.$1", "type": "string", "tags": [], "label": "key", "description": [], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.string", "type": "Function", "tags": [], "label": "string", "description": [], "signature": [ "(options?: ", "StringOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.string.$1", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "StringOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.uri", "type": "Function", "tags": [], "label": "uri", "description": [], "signature": [ "(options?: ", "URIOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.schema.uri.$1", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "URIOptions", " | undefined" ], "path": "packages/kbn-config-schema/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false } ] } }

" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.extendsDeep.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "ExtendsDeepOptions" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.handleError", "type": "Function", "tags": [], "label": "handleError", "description": [], "signature": [ "(type: string, { reason, value }: Record) => any" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.handleError.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.handleError.$2", "type": "Object", "tags": [], "label": "{ reason, value }", "description": [], "signature": [ "Record" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.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, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.validateKey.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ObjectType.validateKey.$2", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.SchemaTypeError", "type": "Class", "tags": [], "label": "SchemaTypeError", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.SchemaTypeError", "text": "SchemaTypeError" }, " extends ", "SchemaError" ], "path": "packages/kbn-config-schema/src/errors/schema_type_error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.SchemaTypeError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/errors/schema_type_error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.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, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.SchemaTypeError.Unnamed.$2", "type": "Array", "tags": [], "label": "path", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-config-schema/src/errors/schema_type_error.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type", "type": "Class", "tags": [], "label": "Type", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.type", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "V" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.__isKbnConfigSchemaType", "type": "boolean", "tags": [], "label": "__isKbnConfigSchemaType", "description": [], "signature": [ "true" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.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, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.Unnamed.$1", "type": "Object", "tags": [], "label": "schema", "description": [], "signature": [ "AnySchema", "" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.Unnamed.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", "" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.extendsDeep", "type": "Function", "tags": [], "label": "extendsDeep", "description": [], "signature": [ "(newOptions: ", "ExtendsDeepOptions", ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.extendsDeep.$1", "type": "Object", "tags": [], "label": "newOptions", "description": [], "signature": [ "ExtendsDeepOptions" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "(value: any, context?: Record, namespace?: string | undefined) => V" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.validate.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.validate.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ "Record" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.validate.$3", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.getSchemaStructure", "type": "Function", "tags": [], "label": "getSchemaStructure", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.SchemaStructureEntry", "text": "SchemaStructureEntry" }, "[]" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.handleError", "type": "Function", "tags": [], "label": "handleError", "description": [], "signature": [ "(type: string, context: Record, path: string[]) => string | void | ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.SchemaTypeError", "text": "SchemaTypeError" } ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.handleError.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.handleError.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ "Record" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Type.handleError.$3", "type": "Array", "tags": [], "label": "path", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ValidationError", "type": "Class", "tags": [], "label": "ValidationError", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ValidationError", "text": "ValidationError" }, " extends ", "SchemaError" ], "path": "packages/kbn-config-schema/src/errors/validation_error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ValidationError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/errors/validation_error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.ValidationError.Unnamed.$1", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.SchemaTypeError", "text": "SchemaTypeError" } ], "path": "packages/kbn-config-schema/src/errors/validation_error.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.ValidationError.Unnamed.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "packages/kbn-config-schema/src/errors/validation_error.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.isConfigSchema", "type": "Function", "tags": [], "label": "isConfigSchema", "description": [], "signature": [ "(obj: any) => boolean" ], "path": "packages/kbn-config-schema/src/typeguards/is_config_schema.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.isConfigSchema.$1", "type": "Any", "tags": [], "label": "obj", "description": [], "signature": [ "any" ], "path": "packages/kbn-config-schema/src/typeguards/is_config_schema.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.offeringBasedSchema", "type": "Function", "tags": [], "label": "offeringBasedSchema", "description": [ "\nHelper to apply different validations depending on whether Kibana is running the Serverless or Traditional offering.\n" ], "signature": [ "(opts: { serverless?: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, " | undefined; traditional?: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, " | undefined; options?: ", "TypeOptions", " | undefined; }) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ConditionalType", "text": "ConditionalType" }, "" ], "path": "packages/kbn-config-schema/src/helpers/offering_based_schema.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.offeringBasedSchema.$1", "type": "Object", "tags": [], "label": "opts", "description": [], "path": "packages/kbn-config-schema/src/helpers/offering_based_schema.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.offeringBasedSchema.$1.serverless", "type": "Object", "tags": [], "label": "serverless", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, " | undefined" ], "path": "packages/kbn-config-schema/src/helpers/offering_based_schema.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.offeringBasedSchema.$1.traditional", "type": "Object", "tags": [], "label": "traditional", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, " | undefined" ], "path": "packages/kbn-config-schema/src/helpers/offering_based_schema.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.offeringBasedSchema.$1.options", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TypeOptions", " | undefined" ], "path": "packages/kbn-config-schema/src/helpers/offering_based_schema.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.SchemaStructureEntry", "type": "Interface", "tags": [], "label": "SchemaStructureEntry", "description": [], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.SchemaStructureEntry.path", "type": "Array", "tags": [], "label": "path", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.SchemaStructureEntry.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "packages/kbn-config-schema/src/types/type.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/config-schema", "id": "def-common.NullableProps", "type": "Type", "tags": [], "label": "NullableProps", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, " | null | undefined; }" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Props", "type": "Type", "tags": [], "label": "Props", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; }" ], "path": "packages/kbn-config-schema/src/types/object_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/config-schema", "id": "def-common.Schema", "type": "Type", "tags": [], "label": "Schema", "description": [], "signature": [ "{ any: (options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.AnyType", "text": "AnyType" }, "; arrayOf: (itemType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "ArrayOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; boolean: (options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; buffer: (options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; byteSize: (options?: ", "ByteSizeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "<", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" }, ">; conditional: (leftOperand: ", "Reference", ", rightOperand: A | ", "Reference", " | ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", equalType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", notEqualType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "TypeOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.ConditionalType", "text": "ConditionalType" }, "; contextRef: (key: string) => ", "ContextReference", "; duration: (options?: ", "DurationOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; ip: (options?: ", "IpOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; literal: (value: T) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; mapOf: (keyType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", valueType: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ", options?: ", "MapOfOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ">; maybe: (type: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; nullable: (type: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; never: () => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; number: (options?: ", "NumberOptions", " | undefined) => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-common.Type", "text": "Type" }, "; object: