{ "id": "@kbn/io-ts-utils", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.createLiteralValueFromUndefinedRT", "type": "Function", "tags": [], "label": "createLiteralValueFromUndefinedRT", "description": [], "signature": [ "(literalValue: LiteralValue) => ", "Type", "" ], "path": "packages/kbn-io-ts-utils/src/literal_value_from_undefined_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.createLiteralValueFromUndefinedRT.$1", "type": "Uncategorized", "tags": [], "label": "literalValue", "description": [], "signature": [ "LiteralValue" ], "path": "packages/kbn-io-ts-utils/src/literal_value_from_undefined_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.createPlainError", "type": "Function", "tags": [], "label": "createPlainError", "description": [], "signature": [ "(message: string) => Error" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.createPlainError.$1", "type": "string", "tags": [], "label": "message", "description": [], "signature": [ "string" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.createRouteValidationFunction", "type": "Function", "tags": [], "label": "createRouteValidationFunction", "description": [], "signature": [ "(runtimeType: ", "Type", ") => ", { "pluginId": "@kbn/core-http-server", "scope": "common", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-common.RouteValidationFunction", "text": "RouteValidationFunction" }, "" ], "path": "packages/kbn-io-ts-utils/src/route_validation/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.createRouteValidationFunction.$1", "type": "Object", "tags": [], "label": "runtimeType", "description": [], "signature": [ "Type", "" ], "path": "packages/kbn-io-ts-utils/src/route_validation/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.decodeOrThrow", "type": "Function", "tags": [], "label": "decodeOrThrow", "description": [], "signature": [ "(runtimeType: ", "Type", ", createError?: ErrorFactory) => (inputValue: InputValue) => DecodedValue" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.decodeOrThrow.$1", "type": "Object", "tags": [], "label": "runtimeType", "description": [], "signature": [ "Type", "" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.decodeOrThrow.$2", "type": "Function", "tags": [], "label": "createError", "description": [], "signature": [ "ErrorFactory" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.deepExactRt", "type": "Function", "tags": [], "label": "deepExactRt", "description": [], "signature": [ "(type: T) => T" ], "path": "packages/kbn-io-ts-utils/src/deep_exact_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.deepExactRt.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "T" ], "path": "packages/kbn-io-ts-utils/src/deep_exact_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.deepExactRt", "type": "Function", "tags": [], "label": "deepExactRt", "description": [], "signature": [ "(type: ", "Type", " | ", "ParseableType", ") => ", "StringType", " | ", "Type", " | ", "NumberType", " | ", "BooleanType", " | ", "RecordC", "<", "Mixed", ", ", "Mixed", "> | ", "ArrayC", "<", "Mixed", "> | ", "ExactC", "<", "TypeC", "<{ [x: string]: ", "Mixed", "; }>> | ", "ExactC", "<", "PartialC", "<{ [x: string]: ", "Mixed", "; }>>" ], "path": "packages/kbn-io-ts-utils/src/deep_exact_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.deepExactRt.$1", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "Type", " | ", "ParseableType" ], "path": "packages/kbn-io-ts-utils/src/deep_exact_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.formatErrors", "type": "Function", "tags": [], "label": "formatErrors", "description": [], "signature": [ "(errors: ", "ValidationError", "[]) => string" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.formatErrors.$1", "type": "Array", "tags": [], "label": "errors", "description": [], "signature": [ "ValidationError", "[]" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.inRangeFromStringRt", "type": "Function", "tags": [], "label": "inRangeFromStringRt", "description": [], "signature": [ "(start: number, end: number) => ", "Type", "" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.inRangeFromStringRt.$1", "type": "number", "tags": [], "label": "start", "description": [], "signature": [ "number" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.inRangeFromStringRt.$2", "type": "number", "tags": [], "label": "end", "description": [], "signature": [ "number" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.inRangeRt", "type": "Function", "tags": [], "label": "inRangeRt", "description": [], "signature": [ "(start: number, end: number) => ", "Type", "" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.inRangeRt.$1", "type": "number", "tags": [], "label": "start", "description": [], "signature": [ "number" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.inRangeRt.$2", "type": "number", "tags": [], "label": "end", "description": [], "signature": [ "number" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.isGreaterOrEqualRt", "type": "Function", "tags": [], "label": "isGreaterOrEqualRt", "description": [], "signature": [ "(value: number) => ", "BrandC", "<", "NumberC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.IsGreaterOrEqualBrand", "text": "IsGreaterOrEqualBrand" }, ">" ], "path": "packages/kbn-io-ts-utils/src/is_greater_or_equal/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.isGreaterOrEqualRt.$1", "type": "number", "tags": [], "label": "value", "description": [], "signature": [ "number" ], "path": "packages/kbn-io-ts-utils/src/is_greater_or_equal/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.mergeRt", "type": "Function", "tags": [], "label": "mergeRt", "description": [], "signature": [ "(a: T1, b: T2) => ", "MergeType", "" ], "path": "packages/kbn-io-ts-utils/src/merge_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.mergeRt.$1", "type": "Uncategorized", "tags": [], "label": "a", "description": [], "signature": [ "T1" ], "path": "packages/kbn-io-ts-utils/src/merge_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.mergeRt.$2", "type": "Uncategorized", "tags": [], "label": "b", "description": [], "signature": [ "T2" ], "path": "packages/kbn-io-ts-utils/src/merge_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.mergeRt", "type": "Function", "tags": [], "label": "mergeRt", "description": [], "signature": [ "(types: ", "Any", "[]) => { _tag: string; types: ", "Any", "[]; name: string; is: ", "Is", "; validate: ", "Validate", "; encode: ", "Encode", "; _A: any; _O: any; _I: unknown; }" ], "path": "packages/kbn-io-ts-utils/src/merge_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.mergeRt.$1", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "Any", "[]" ], "path": "packages/kbn-io-ts-utils/src/merge_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.strictKeysRt", "type": "Function", "tags": [], "label": "strictKeysRt", "description": [], "signature": [ "(type: T) => ", "Type", "" ], "path": "packages/kbn-io-ts-utils/src/strict_keys_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.strictKeysRt.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "T" ], "path": "packages/kbn-io-ts-utils/src/strict_keys_rt/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.throwErrors", "type": "Function", "tags": [], "label": "throwErrors", "description": [], "signature": [ "(createError: ErrorFactory) => (errors: ", "Errors", ") => never" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.throwErrors.$1", "type": "Function", "tags": [], "label": "createError", "description": [], "signature": [ "ErrorFactory" ], "path": "packages/kbn-io-ts-utils/src/decode_or_throw.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.toJsonSchema", "type": "Function", "tags": [], "label": "toJsonSchema", "description": [], "signature": [ "(type: ", "Mixed", ") => JSONSchema" ], "path": "packages/kbn-io-ts-utils/src/to_json_schema/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.toJsonSchema.$1", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ "Mixed" ], "path": "packages/kbn-io-ts-utils/src/to_json_schema/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.InRangeBrand", "type": "Interface", "tags": [], "label": "InRangeBrand", "description": [], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.InRangeBrand.InRange", "type": "Uncategorized", "tags": [], "label": "InRange", "description": [], "signature": [ "typeof ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.InRangeBrand", "text": "InRangeBrand" }, "[\"InRange\"]" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.IsGreaterOrEqualBrand", "type": "Interface", "tags": [], "label": "IsGreaterOrEqualBrand", "description": [], "path": "packages/kbn-io-ts-utils/src/is_greater_or_equal/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.IsGreaterOrEqualBrand.IsGreaterOrEqual", "type": "Uncategorized", "tags": [], "label": "IsGreaterOrEqual", "description": [], "signature": [ "typeof ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.IsGreaterOrEqualBrand", "text": "IsGreaterOrEqualBrand" }, "[\"IsGreaterOrEqual\"]" ], "path": "packages/kbn-io-ts-utils/src/is_greater_or_equal/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.NonEmptyStringBrand", "type": "Interface", "tags": [], "label": "NonEmptyStringBrand", "description": [], "path": "packages/kbn-io-ts-utils/src/non_empty_string_rt/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.NonEmptyStringBrand.NonEmptyString", "type": "Uncategorized", "tags": [], "label": "NonEmptyString", "description": [], "signature": [ "typeof ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, "[\"NonEmptyString\"]" ], "path": "packages/kbn-io-ts-utils/src/non_empty_string_rt/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.IndexPattern", "type": "Type", "tags": [], "label": "IndexPattern", "description": [], "signature": [ "string & ", "Brand", "<", "IndexPatternBrand", ">" ], "path": "packages/kbn-io-ts-utils/src/index_pattern_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.InRange", "type": "Type", "tags": [], "label": "InRange", "description": [], "signature": [ "number & ", "Brand", "<", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.InRangeBrand", "text": "InRangeBrand" }, ">" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.IsGreaterOrEqual", "type": "Type", "tags": [], "label": "IsGreaterOrEqual", "description": [], "signature": [ "number & ", "Brand", "<", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.IsGreaterOrEqualBrand", "text": "IsGreaterOrEqualBrand" }, ">" ], "path": "packages/kbn-io-ts-utils/src/is_greater_or_equal/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.NonEmptyString", "type": "Type", "tags": [], "label": "NonEmptyString", "description": [], "signature": [ "string & ", "Brand", "<", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">" ], "path": "packages/kbn-io-ts-utils/src/non_empty_string_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.datemathStringRt", "type": "Object", "tags": [], "label": "datemathStringRt", "description": [], "signature": [ "Type", "" ], "path": "packages/kbn-io-ts-utils/src/datemath_string_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.dateRt", "type": "Object", "tags": [], "label": "dateRt", "description": [], "signature": [ "BrandC", "<", "StringC", ", ", "DateBrand", ">" ], "path": "packages/kbn-io-ts-utils/src/date_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.indexPatternRt", "type": "Object", "tags": [], "label": "indexPatternRt", "description": [], "signature": [ "BrandC", "<", "StringC", ", ", "IndexPatternBrand", ">" ], "path": "packages/kbn-io-ts-utils/src/index_pattern_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.isoToEpochRt", "type": "Object", "tags": [], "label": "isoToEpochRt", "description": [], "signature": [ "Type", "" ], "path": "packages/kbn-io-ts-utils/src/iso_to_epoch_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.jsonRt", "type": "Object", "tags": [], "label": "jsonRt", "description": [], "signature": [ "Type", "" ], "path": "packages/kbn-io-ts-utils/src/json_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.nonEmptyStringRt", "type": "Object", "tags": [], "label": "nonEmptyStringRt", "description": [], "signature": [ "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">" ], "path": "packages/kbn-io-ts-utils/src/non_empty_string_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.toBooleanRt", "type": "Object", "tags": [], "label": "toBooleanRt", "description": [], "signature": [ "Type", "" ], "path": "packages/kbn-io-ts-utils/src/to_boolean_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/io-ts-utils", "id": "def-common.toNumberRt", "type": "Object", "tags": [], "label": "toNumberRt", "description": [], "signature": [ "Type", "" ], "path": "packages/kbn-io-ts-utils/src/to_number_rt/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ] } }