{ "id": "@kbn/securitysolution-io-ts-utils", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.exactCheck", "type": "Function", "tags": [], "label": "exactCheck", "description": [ "\nGiven an original object and a decoded object this will return an error\nif and only if the original object has additional keys that the decoded\nobject does not have. If the original decoded already has an error, then\nthis will return the error as is and not continue.\n\nNOTE: You MUST use t.exact(...) for this to operate correctly as your schema\nneeds to remove additional keys before the compare\n\nYou might not need this in the future if the below issue is solved:\nhttps://github.com/gcanti/io-ts/issues/322\n" ], "signature": [ "(original: unknown, decoded: ", "Either", "<", "Errors", ", T>) => ", "Either", "<", "Errors", ", T>" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/exact_check/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.exactCheck.$1", "type": "Unknown", "tags": [], "label": "original", "description": [ "The original to check if it has additional keys" ], "signature": [ "unknown" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/exact_check/index.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.exactCheck.$2", "type": "CompoundType", "tags": [], "label": "decoded", "description": [ "The decoded either which has either an existing error or the\ndecoded object which could have additional keys stripped from it." ], "signature": [ "Either", "<", "Errors", ", T>" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/exact_check/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.findDifferencesRecursive", "type": "Function", "tags": [], "label": "findDifferencesRecursive", "description": [], "signature": [ "(original: unknown, decodedValue: T) => string[]" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/exact_check/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.findDifferencesRecursive.$1", "type": "Unknown", "tags": [], "label": "original", "description": [], "signature": [ "unknown" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/exact_check/index.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.findDifferencesRecursive.$2", "type": "Uncategorized", "tags": [], "label": "decodedValue", "description": [], "signature": [ "T" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/exact_check/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.foldLeftRight", "type": "Function", "tags": [], "label": "foldLeftRight", "description": [], "signature": [ "(ma: ", "Either", "<", "Errors", ", unknown>) => Message" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/test_utils/index.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.foldLeftRight.$1", "type": "CompoundType", "tags": [], "label": "ma", "description": [], "signature": [ "Left", " | ", "Right", "" ], "path": "node_modules/fp-ts/lib/Either.d.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.formatErrors", "type": "Function", "tags": [], "label": "formatErrors", "description": [], "signature": [ "(errors: ", "Errors", ") => string[]" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/format_errors/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.formatErrors.$1", "type": "Object", "tags": [], "label": "errors", "description": [], "signature": [ "Errors" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/format_errors/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.getPaths", "type": "Function", "tags": [], "label": "getPaths", "description": [ "\nConvenience utility to keep the error message handling within tests to be\nvery concise." ], "signature": [ "(validation: ", "Either", "<", "Errors", ", A>) => string[]" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/test_utils/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.getPaths.$1", "type": "CompoundType", "tags": [], "label": "validation", "description": [ "The validation to get the errors from" ], "signature": [ "Either", "<", "Errors", ", A>" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/test_utils/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.parseScheduleDates", "type": "Function", "tags": [], "label": "parseScheduleDates", "description": [], "signature": [ "(time: string) => moment.Moment | null" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/parse_schedule_dates/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.parseScheduleDates.$1", "type": "string", "tags": [], "label": "time", "description": [], "signature": [ "string" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/parse_schedule_dates/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.removeExternalLinkText", "type": "Function", "tags": [], "label": "removeExternalLinkText", "description": [ "\nConvenience utility to remove text appended to links by EUI" ], "signature": [ "(str: string) => string" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/test_utils/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.removeExternalLinkText.$1", "type": "string", "tags": [], "label": "str", "description": [], "signature": [ "string" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/test_utils/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "(obj: object, schema: T) => [", "TypeOf", " | null, string | null]" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validate.$1", "type": "Uncategorized", "tags": [], "label": "obj", "description": [], "signature": [ "object" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validate.$2", "type": "Uncategorized", "tags": [], "label": "schema", "description": [], "signature": [ "T" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateEither", "type": "Function", "tags": [], "label": "validateEither", "description": [], "signature": [ "(schema: T, obj: A) => ", "Either", "" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateEither.$1", "type": "Uncategorized", "tags": [], "label": "schema", "description": [], "signature": [ "T" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateEither.$2", "type": "Uncategorized", "tags": [], "label": "obj", "description": [], "signature": [ "A" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateNonExact", "type": "Function", "tags": [], "label": "validateNonExact", "description": [], "signature": [ "(obj: unknown, schema: T) => [", "TypeOf", " | null, string | null]" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateNonExact.$1", "type": "Unknown", "tags": [], "label": "obj", "description": [], "signature": [ "unknown" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateNonExact.$2", "type": "Uncategorized", "tags": [], "label": "schema", "description": [], "signature": [ "T" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateTaskEither", "type": "Function", "tags": [], "label": "validateTaskEither", "description": [], "signature": [ "(schema: T, obj: A) => ", "TaskEither", "" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateTaskEither.$1", "type": "Uncategorized", "tags": [], "label": "schema", "description": [], "signature": [ "T" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/securitysolution-io-ts-utils", "id": "def-common.validateTaskEither.$2", "type": "Uncategorized", "tags": [], "label": "obj", "description": [], "signature": [ "A" ], "path": "packages/kbn-securitysolution-io-ts-utils/src/validate/index.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [], "objects": [] } }