855 lines
35 KiB
JSON
855 lines
35 KiB
JSON
{
|
|
"id": "@kbn/securitysolution-autocomplete",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldExistsComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AutocompleteFieldExistsComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ({ placeholder, rowLabel, }: React.PropsWithChildren<AutocompleteFieldExistsProps>): JSX.Element; displayName: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_exists/index.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldExistsComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n placeholder,\n rowLabel,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<AutocompleteFieldExistsProps>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_exists/index.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldListsComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AutocompleteFieldListsComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ({ httpService, isClearable, isDisabled, isLoading, onChange, placeholder, rowLabel, selectedField, selectedValue, }: React.PropsWithChildren<AutocompleteFieldListsProps>): JSX.Element; displayName: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldListsComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n httpService,\n isClearable = false,\n isDisabled = false,\n isLoading = false,\n onChange,\n placeholder,\n rowLabel,\n selectedField,\n selectedValue,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<AutocompleteFieldListsProps>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldMatchAnyComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AutocompleteFieldMatchAnyComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ({ placeholder, rowLabel, selectedField, selectedValue, indexPattern, isLoading, isDisabled, isClearable, isRequired, onChange, onError, autocompleteService, }: React.PropsWithChildren<AutocompleteFieldMatchAnyProps>): JSX.Element; displayName: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_match_any/index.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldMatchAnyComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n placeholder,\n rowLabel,\n selectedField,\n selectedValue,\n indexPattern,\n isLoading,\n isDisabled = false,\n isClearable = false,\n isRequired = false,\n onChange,\n onError,\n autocompleteService,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<AutocompleteFieldMatchAnyProps>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_match_any/index.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldMatchComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AutocompleteFieldMatchComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ({ placeholder, rowLabel, selectedField, selectedValue, indexPattern, isLoading, isDisabled, isClearable, isRequired, fieldInputWidth, onChange, onError, autocompleteService, }: React.PropsWithChildren<AutocompleteFieldMatchProps>): JSX.Element; displayName: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_match/index.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.AutocompleteFieldMatchComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n placeholder,\n rowLabel,\n selectedField,\n selectedValue,\n indexPattern,\n isLoading,\n isDisabled = false,\n isClearable = false,\n isRequired = false,\n fieldInputWidth,\n onChange,\n onError,\n autocompleteService,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<AutocompleteFieldMatchProps>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field_value_match/index.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.checkEmptyValue",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "checkEmptyValue",
|
|
"description": [
|
|
"\nDetermines if empty value is ok"
|
|
],
|
|
"signature": [
|
|
"(param: string | undefined, field: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" | undefined, isRequired: boolean, touched: boolean) => string | null | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/check_empty_value/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.checkEmptyValue.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "param",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/check_empty_value/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.checkEmptyValue.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/check_empty_value/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.checkEmptyValue.$3",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isRequired",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/check_empty_value/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.checkEmptyValue.$4",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "touched",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/check_empty_value/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.FieldComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "FieldComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ({ fieldInputWidth, fieldTypeFilter, indexPattern, isClearable, isDisabled, isLoading, isRequired, onChange, placeholder, selectedField, }: React.PropsWithChildren<OperatorProps>): JSX.Element; displayName: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field/index.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.FieldComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n fieldInputWidth,\n fieldTypeFilter = [],\n indexPattern,\n isClearable = false,\n isDisabled = false,\n isLoading = false,\n isRequired = false,\n onChange,\n placeholder,\n selectedField,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<OperatorProps>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/field/index.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.filterFieldToList",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "filterFieldToList",
|
|
"description": [
|
|
"\nGiven an array of lists and optionally a field this will return all\nthe lists that match against the field based on the types from the field\n\nNOTE: That we support one additional property from \"FieldSpec\" located here:\nsrc/plugins/data/common/index_patterns/fields/types.ts\nThis type property is esTypes. If it exists and is on there we will read off the esTypes."
|
|
],
|
|
"signature": [
|
|
"(lists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[], field?: (",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" & { esTypes?: string[] | undefined; }) | undefined) => { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.filterFieldToList.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "lists",
|
|
"description": [
|
|
"The lists to match against the field"
|
|
],
|
|
"signature": [
|
|
"{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.filterFieldToList.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [
|
|
"The field to check against the list to see if they are compatible"
|
|
],
|
|
"signature": [
|
|
"(",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" & { esTypes?: string[] | undefined; }) | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getGenericComboBoxProps",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getGenericComboBoxProps",
|
|
"description": [
|
|
"\nDetermines the options, selected values and option labels for EUI combo box"
|
|
],
|
|
"signature": [
|
|
"<T>({ getLabel, options, selectedOptions, }: { getLabel: (value: T) => string; options: T[]; selectedOptions: T[]; }) => ",
|
|
{
|
|
"pluginId": "@kbn/securitysolution-autocomplete",
|
|
"scope": "common",
|
|
"docId": "kibKbnSecuritysolutionAutocompletePluginApi",
|
|
"section": "def-common.GetGenericComboBoxPropsReturn",
|
|
"text": "GetGenericComboBoxPropsReturn"
|
|
}
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getGenericComboBoxProps.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n getLabel,\n options,\n selectedOptions,\n}",
|
|
"description": [],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getGenericComboBoxProps.$1.getLabel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: T) => string"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getGenericComboBoxProps.$1.getLabel.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getGenericComboBoxProps.$1.options",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"T[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getGenericComboBoxProps.$1.selectedOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "selectedOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"T[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getOperators",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOperators",
|
|
"description": [
|
|
"\nReturns the appropriate operators given a field type\n"
|
|
],
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/securitysolution-list-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
|
|
"section": "def-common.OperatorOption",
|
|
"text": "OperatorOption"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_operators/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.getOperators.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [
|
|
"IndexPatternFieldBase selected field"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_operators/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.OperatorComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "OperatorComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ({ isClearable, isDisabled, isLoading, onChange, operator, operatorOptions, operatorInputWidth, placeholder, selectedField, }: React.PropsWithChildren<OperatorState>): JSX.Element; displayName: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/operator/index.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.OperatorComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n isClearable = false,\n isDisabled = false,\n isLoading = false,\n onChange,\n operator,\n operatorOptions,\n operatorInputWidth = 150,\n placeholder,\n selectedField,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<OperatorState>"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/operator/index.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.paramIsValid",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "paramIsValid",
|
|
"description": [
|
|
"\nVery basic validation for values"
|
|
],
|
|
"signature": [
|
|
"(param: string | undefined, field: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" | undefined, isRequired: boolean, touched: boolean) => string | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/param_is_valid/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.paramIsValid.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "param",
|
|
"description": [
|
|
"the value being checked"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/param_is_valid/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.paramIsValid.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [
|
|
"the selected field"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/param_is_valid/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.paramIsValid.$3",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isRequired",
|
|
"description": [
|
|
"whether or not an empty value is allowed"
|
|
],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/param_is_valid/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.paramIsValid.$4",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "touched",
|
|
"description": [
|
|
"has field been touched by user"
|
|
],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/param_is_valid/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"undefined if valid, string with error message if invalid"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.useFieldValueAutocomplete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useFieldValueAutocomplete",
|
|
"description": [
|
|
"\nHook for using the field value autocomplete service"
|
|
],
|
|
"signature": [
|
|
"({ selectedField, operatorType, fieldValue, query, indexPattern, autocompleteService, }: ",
|
|
{
|
|
"pluginId": "@kbn/securitysolution-autocomplete",
|
|
"scope": "common",
|
|
"docId": "kibKbnSecuritysolutionAutocompletePluginApi",
|
|
"section": "def-common.UseFieldValueAutocompleteProps",
|
|
"text": "UseFieldValueAutocompleteProps"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/securitysolution-autocomplete",
|
|
"scope": "common",
|
|
"docId": "kibKbnSecuritysolutionAutocompletePluginApi",
|
|
"section": "def-common.UseFieldValueAutocompleteReturn",
|
|
"text": "UseFieldValueAutocompleteReturn"
|
|
}
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.useFieldValueAutocomplete.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n selectedField,\n operatorType,\n fieldValue,\n query,\n indexPattern,\n autocompleteService,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/securitysolution-autocomplete",
|
|
"scope": "common",
|
|
"docId": "kibKbnSecuritysolutionAutocompletePluginApi",
|
|
"section": "def-common.UseFieldValueAutocompleteProps",
|
|
"text": "UseFieldValueAutocompleteProps"
|
|
}
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.GetGenericComboBoxPropsReturn",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetGenericComboBoxPropsReturn",
|
|
"description": [],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.GetGenericComboBoxPropsReturn.comboOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "comboOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"EuiComboBoxOptionOption",
|
|
"<string | number | string[] | undefined>[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.GetGenericComboBoxPropsReturn.labels",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "labels",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.GetGenericComboBoxPropsReturn.selectedComboOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "selectedComboOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"EuiComboBoxOptionOption",
|
|
"<string | number | string[] | undefined>[]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UseFieldValueAutocompleteProps",
|
|
"description": [],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteProps.autocompleteService",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "autocompleteService",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteProps.fieldValue",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "fieldValue",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[] | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteProps.indexPattern",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewBase",
|
|
"text": "DataViewBase"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteProps.operatorType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "operatorType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/securitysolution-io-ts-list-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
|
|
"section": "def-common.ListOperatorTypeEnum",
|
|
"text": "ListOperatorTypeEnum"
|
|
}
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteProps.query",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteProps.selectedField",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "selectedField",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.DataViewFieldBase",
|
|
"text": "DataViewFieldBase"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/securitysolution-autocomplete",
|
|
"id": "def-common.UseFieldValueAutocompleteReturn",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UseFieldValueAutocompleteReturn",
|
|
"description": [],
|
|
"signature": [
|
|
"[boolean, boolean, string[], Func | null]"
|
|
],
|
|
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |