{ "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" }, "
extends ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
" | undefined; } & { [K in keyof Pick ? never : Key; }[keyof P]>]: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.TypeOf",
"text": "TypeOf"
},
" ; }>>"
],
"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",
" "
],
"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": [
" "
],
"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",
"