* Add packages * Update docs * Fix test and types * debug heap size * remove debug heap line * updated docs # Conflicts: # api_docs/alerting.mdx # api_docs/apm.json # api_docs/core.mdx # api_docs/core_application.mdx # api_docs/core_chrome.mdx # api_docs/core_http.mdx # api_docs/core_saved_objects.mdx # api_docs/custom_integrations.mdx # api_docs/data.json # api_docs/data.mdx # api_docs/data_autocomplete.mdx # api_docs/data_data_views.json # api_docs/data_data_views.mdx # api_docs/data_query.mdx # api_docs/data_search.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/discover_enhanced.json # api_docs/embeddable.json # api_docs/event_log.mdx # api_docs/fleet.mdx # api_docs/home.json # api_docs/index_management.json # api_docs/interactive_setup.mdx # api_docs/kibana_legacy.json # api_docs/kibana_legacy.mdx # api_docs/observability.mdx # api_docs/plugin_directory.mdx # api_docs/security_oss.mdx
760 lines
No EOL
26 KiB
JSON
760 lines
No EOL
26 KiB
JSON
{
|
|
"id": "@kbn/securitysolution-io-ts-types",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultArray",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "DefaultArray",
|
|
"description": [
|
|
"\nTypes the DefaultArray<C> as:\n - If undefined, then a default array will be set\n - If an array is sent in, then the array will be validated to ensure all elements are type C"
|
|
],
|
|
"signature": [
|
|
"<C extends ",
|
|
"Mixed",
|
|
">(codec: C) => ",
|
|
"Type",
|
|
"<",
|
|
"TypeOf",
|
|
"<C>[], ",
|
|
"TypeOf",
|
|
"<C>[] | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_array/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultArray.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "codec",
|
|
"description": [],
|
|
"signature": [
|
|
"C"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_array/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.enumeration",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "enumeration",
|
|
"description": [
|
|
"\nConverts string value to a Typescript enum\n - \"foo\" -> MyEnum.foo\n"
|
|
],
|
|
"signature": [
|
|
"(name: string, originalEnum: Record<string, EnumType>) => ",
|
|
"Type",
|
|
"<EnumType, EnumType, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/enumeration/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.enumeration.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"Enum name"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/enumeration/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.enumeration.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "originalEnum",
|
|
"description": [
|
|
"Typescript enum"
|
|
],
|
|
"signature": [
|
|
"Record<string, EnumType>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/enumeration/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"Codec"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyArray",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "NonEmptyArray",
|
|
"description": [],
|
|
"signature": [
|
|
"<C extends ",
|
|
"Mixed",
|
|
">(codec: C, name?: string) => ",
|
|
"Type",
|
|
"<",
|
|
"TypeOf",
|
|
"<C>[], ",
|
|
"TypeOf",
|
|
"<C>[], unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_array/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyArray.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "codec",
|
|
"description": [],
|
|
"signature": [
|
|
"C"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_array/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyArray.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_array/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultStringBooleanFalseC",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DefaultStringBooleanFalseC",
|
|
"description": [],
|
|
"signature": [
|
|
"Type",
|
|
"<boolean, string | boolean | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_string_boolean_false/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultVersionNumberDecoded",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DefaultVersionNumberDecoded",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_version_number/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.EmptyStringArrayDecoded",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmptyStringArrayDecoded",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/empty_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.EmptyStringArrayEncoded",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmptyStringArrayEncoded",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/empty_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.IsoDateStringC",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IsoDateStringC",
|
|
"description": [],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/iso_date_string/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyOrNullableStringArray",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NonEmptyOrNullableStringArray",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_or_nullable_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyOrNullableStringArrayDecoded",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NonEmptyOrNullableStringArrayDecoded",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_or_nullable_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyStringArray",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NonEmptyStringArray",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyStringArrayDecoded",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NonEmptyStringArrayDecoded",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyStringC",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NonEmptyStringC",
|
|
"description": [],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_string/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.Operator",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Operator",
|
|
"description": [],
|
|
"signature": [
|
|
"\"equals\""
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/operator/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.OperatorEnum",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "OperatorEnum",
|
|
"description": [],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/operator/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.StringToPositiveNumberC",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "StringToPositiveNumberC",
|
|
"description": [],
|
|
"signature": [
|
|
"Type",
|
|
"<number, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/string_to_positive_number/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.UUIDC",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UUIDC",
|
|
"description": [],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/uuid/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.Version",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Version",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/version/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.VersionOrUndefined",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VersionOrUndefined",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/version/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultBooleanFalse",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DefaultBooleanFalse",
|
|
"description": [
|
|
"\nTypes the DefaultBooleanFalse as:\n - If null or undefined, then a default false will be set"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<boolean, boolean | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_boolean_false/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultBooleanTrue",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DefaultBooleanTrue",
|
|
"description": [
|
|
"\nTypes the DefaultBooleanTrue as:\n - If null or undefined, then a default true will be set"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<boolean, boolean | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_boolean_true/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultEmptyString",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DefaultEmptyString",
|
|
"description": [
|
|
"\nTypes the DefaultEmptyString as:\n - If null or undefined, then a default of an empty string \"\" will be used"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_empty_string/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultStringArray",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DefaultStringArray",
|
|
"description": [
|
|
"\nTypes the DefaultStringArray as:\n - If undefined, then a default array will be set\n - If an array is sent in, then the array will be validated to ensure all elements are a string"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string[], string[] | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultStringBooleanFalse",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DefaultStringBooleanFalse",
|
|
"description": [
|
|
"\nTypes the DefaultStringBooleanFalse as:\n - If a string this will convert the string to a boolean\n - If null or undefined, then a default false will be set"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<boolean, string | boolean | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_string_boolean_false/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultUuid",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DefaultUuid",
|
|
"description": [
|
|
"\nTypes the DefaultUuid as:\n - If null or undefined, then a default string uuid.v4() will be\n created otherwise it will be checked just against an empty string"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_uuid/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.DefaultVersionNumber",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DefaultVersionNumber",
|
|
"description": [
|
|
"\nTypes the DefaultVersionNumber as:\n - If null or undefined, then a default of the number 1 will be used"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<number, number | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/default_version_number/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.EmptyStringArray",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "EmptyStringArray",
|
|
"description": [
|
|
"\nTypes the EmptyStringArray as:\n - A value that can be undefined, or null (which will be turned into an empty array)\n - A comma separated string that can turn into an array by splitting on it\n - Example input converted to output: undefined -> []\n - Example input converted to output: null -> []\n - Example input converted to output: \"a,b,c\" -> [\"a\", \"b\", \"c\"]"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string[], string | null | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/empty_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.IsoDateString",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "IsoDateString",
|
|
"description": [
|
|
"\nTypes the IsoDateString as:\n - A string that is an ISOString"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/iso_date_string/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.nonEmptyOrNullableStringArray",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "nonEmptyOrNullableStringArray",
|
|
"description": [
|
|
"\nTypes the nonEmptyOrNullableStringArray as:\n - An array of non empty strings of length 1 or greater\n - This differs from NonEmptyStringArray in that both input and output are type array\n"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string[], string[], unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_or_nullable_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyString",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "NonEmptyString",
|
|
"description": [
|
|
"\nTypes the NonEmptyString as:\n - A string that is not empty"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_string/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.NonEmptyStringArray",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "NonEmptyStringArray",
|
|
"description": [
|
|
"\nTypes the NonEmptyStringArray as:\n - A string that is not empty (which will be turned into an array of size 1)\n - A comma separated string that can turn into an array by splitting on it\n - Example input converted to output: \"a,b,c\" -> [\"a\", \"b\", \"c\"]"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string[], string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/non_empty_string_array/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.OnlyFalseAllowed",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "OnlyFalseAllowed",
|
|
"description": [
|
|
"\nTypes the OnlyFalseAllowed as:\n - If null or undefined, then a default false will be set\n - If true is sent in then this will return an error\n - If false is sent in then this will allow it only false"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<boolean, boolean | undefined, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/only_false_allowed/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.operator",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "operator",
|
|
"description": [],
|
|
"signature": [
|
|
"KeyofC",
|
|
"<{ equals: null; }>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/operator/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.operatorIncluded",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "operatorIncluded",
|
|
"description": [],
|
|
"signature": [
|
|
"KeyofC",
|
|
"<{ included: null; }>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/operator/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.PositiveInteger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "PositiveInteger",
|
|
"description": [
|
|
"\nTypes the positive integer are:\n - Natural Number (positive integer and not a float),\n - zero or greater"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<number, number, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/positive_integer/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.PositiveIntegerGreaterThanZero",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "PositiveIntegerGreaterThanZero",
|
|
"description": [
|
|
"\nTypes the positive integer greater than zero is:\n - Natural Number (positive integer and not a float),\n - 1 or greater"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<number, number, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/positive_integer_greater_than_zero/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.StringToPositiveNumber",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "StringToPositiveNumber",
|
|
"description": [
|
|
"\nTypes the StrongToPositiveNumber as:\n - If a string this converts the string into a number\n - Ensures it is a number (and not NaN)\n - Ensures it is positive number"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<number, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/string_to_positive_number/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.UUID",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "UUID",
|
|
"description": [
|
|
"\nTypes the risk score as:\n - Natural Number (positive integer and not a float),\n - Between the values [0 and 100] inclusive."
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<string, string, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/uuid/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.version",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nNote this is just a positive number, but we use it as a type here which is still ok.\nThis type was originally from \"x-pack/plugins/security_solution/common/detection_engine/schemas/common/schemas.ts\"\nbut is moved here to make things more portable. No unit tests, but see PositiveIntegerGreaterThanZero integer for unit tests."
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<number, number, unknown>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/version/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-io-ts-types",
|
|
"id": "def-common.versionOrUndefined",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "versionOrUndefined",
|
|
"description": [],
|
|
"signature": [
|
|
"UnionC",
|
|
"<[",
|
|
"Type",
|
|
"<number, number, unknown>, ",
|
|
"UndefinedC",
|
|
"]>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-io-ts-types/src/version/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |