maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/kibana_utils.json
Stacey Gammon 503cfcf8c9
Track API stats as part of ci (#95733) 
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00

9000 lines
287 KiB
JSON
Raw Blame History

{
"id": "kibanaUtils",
"client": {
"classes": [
{
"id": "def-public.AbortError",
"type": "Class",
"tags": [],
"label": "AbortError",
"description": [
"\nClass used to signify that something was aborted. Useful for applications to conditionally handle\nthis type of error differently than other errors."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.AbortError",
"text": "AbortError"
},
" extends Error"
],
"children": [
{
"id": "def-public.AbortError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.AbortError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 14
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-public.Defer",
"type": "Class",
"tags": [],
"label": "Defer",
"description": [
"\nAn externally resolvable/rejectable \"promise\". Use it to resolve/reject\npromise at any time.\n\n```ts\nconst future = new Defer();\n\nfuture.promise.then(value => console.log(value));\n\nfuture.resolve(123);\n```"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Defer",
"text": "Defer"
},
"<T>"
],
"children": [
{
"tags": [],
"id": "def-public.Defer.resolve",
"type": "Function",
"label": "resolve",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 22
},
"signature": [
"(data: T) => void"
]
},
{
"tags": [],
"id": "def-public.Defer.reject",
"type": "Function",
"label": "reject",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 23
},
"signature": [
"(error: any) => void"
]
},
{
"tags": [],
"id": "def-public.Defer.promise",
"type": "Object",
"label": "promise",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 24
},
"signature": [
"Promise<T>"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-public.DuplicateField",
"type": "Class",
"tags": [],
"label": "DuplicateField",
"description": [
"\nwhen a mapping already exists for a field the user is attempting to add"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.DuplicateField",
"text": "DuplicateField"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-public.DuplicateField.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.DuplicateField.Unnamed.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 24
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 24
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 23
},
"initialIsOpen": false
},
{
"id": "def-public.HashedItemStore",
"type": "Class",
"tags": [],
"label": "HashedItemStore",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.HashedItemStore",
"text": "HashedItemStore"
},
" implements ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorage",
"text": "IStorage"
},
"<string, boolean>"
],
"children": [
{
"tags": [],
"id": "def-public.HashedItemStore.PERSISTED_INDEX_KEY",
"type": "string",
"label": "PERSISTED_INDEX_KEY",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 71
},
"signature": [
"\"kbn.hashedItemsIndex.v1\""
]
},
{
"id": "def-public.HashedItemStore.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [
"\nHashedItemStore uses objects called indexed items to refer to items that have been persisted\nin storage. An indexed item is shaped {hash, touched}. The touched date is when the item\nwas last referenced by the browser history."
],
"children": [
{
"id": "def-public.HashedItemStore.Unnamed.$1",
"type": "Object",
"label": "storage",
"isRequired": true,
"signature": [
"Storage"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 79
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 79
}
},
{
"id": "def-public.HashedItemStore.setItem",
"type": "Function",
"label": "setItem",
"signature": [
"(hash: string, item: string) => boolean"
],
"description": [],
"children": [
{
"id": "def-public.HashedItemStore.setItem.$1",
"type": "string",
"label": "hash",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 83
}
},
{
"id": "def-public.HashedItemStore.setItem.$2",
"type": "string",
"label": "item",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 83
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 83
}
},
{
"id": "def-public.HashedItemStore.getItem",
"type": "Function",
"label": "getItem",
"signature": [
"(hash: string) => string | null"
],
"description": [],
"children": [
{
"id": "def-public.HashedItemStore.getItem.$1",
"type": "string",
"label": "hash",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 93
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 93
}
},
{
"id": "def-public.HashedItemStore.removeItem",
"type": "Function",
"label": "removeItem",
"signature": [
"(hash: string) => string | null"
],
"description": [],
"children": [
{
"id": "def-public.HashedItemStore.removeItem.$1",
"type": "string",
"label": "hash",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 103
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 103
}
},
{
"id": "def-public.HashedItemStore.clear",
"type": "Function",
"label": "clear",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 120
}
}
],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/hashed_item_store.ts",
"lineNumber": 70
},
"initialIsOpen": false
},
{
"id": "def-public.InvalidJSONProperty",
"type": "Class",
"tags": [],
"label": "InvalidJSONProperty",
"description": [
"\nThis error is for scenarios where a saved object is detected that has invalid JSON properties.\nThere was a scenario where we were importing objects with double-encoded JSON, and the system\nwas silently failing. This error is now thrown in those scenarios."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.InvalidJSONProperty",
"text": "InvalidJSONProperty"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-public.InvalidJSONProperty.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.InvalidJSONProperty.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 74
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 74
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 73
},
"initialIsOpen": false
},
{
"id": "def-public.KbnError",
"type": "Class",
"tags": [],
"label": "KbnError",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
},
" extends Error"
],
"children": [
{
"id": "def-public.KbnError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.KbnError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 13
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 13
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-public.RenderCompleteDispatcher",
"type": "Class",
"tags": [],
"label": "RenderCompleteDispatcher",
"description": [
"\nShould call `dispatchComplete()` when UI block has finished loading its data and has\ncompletely rendered. Should `dispatchInProgress()` every time UI block\nstarts loading data again. At the start it is assumed that UI block is loading\nso it dispatches \"in progress\" automatically, so you need to call `setRenderComplete`\nat least once.\n\nThis is used for reporting to know that UI block is ready, so\nit can take a screenshot. It is also used in functional tests to know that\npage has stabilized."
],
"children": [
{
"id": "def-public.RenderCompleteDispatcher.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.RenderCompleteDispatcher.Unnamed.$1",
"type": "Object",
"label": "el",
"isRequired": false,
"signature": [
"HTMLElement | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 36
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 36
}
},
{
"id": "def-public.RenderCompleteDispatcher.setEl",
"type": "Function",
"label": "setEl",
"signature": [
"(el?: HTMLElement | undefined) => void"
],
"description": [],
"children": [
{
"id": "def-public.RenderCompleteDispatcher.setEl.$1",
"type": "Object",
"label": "el",
"isRequired": false,
"signature": [
"HTMLElement | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 40
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 40
}
},
{
"id": "def-public.RenderCompleteDispatcher.dispatchInProgress",
"type": "Function",
"label": "dispatchInProgress",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 46
}
},
{
"id": "def-public.RenderCompleteDispatcher.dispatchComplete",
"type": "Function",
"label": "dispatchComplete",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 53
}
},
{
"id": "def-public.RenderCompleteDispatcher.dispatchError",
"type": "Function",
"label": "dispatchError",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 61
}
},
{
"id": "def-public.RenderCompleteDispatcher.setTitle",
"type": "Function",
"label": "setTitle",
"signature": [
"(title: string) => void"
],
"description": [],
"children": [
{
"id": "def-public.RenderCompleteDispatcher.setTitle.$1",
"type": "string",
"label": "title",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 68
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 68
}
}
],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 32
},
"initialIsOpen": false
},
{
"id": "def-public.RenderCompleteListener",
"type": "Class",
"tags": [],
"label": "RenderCompleteListener",
"description": [],
"children": [
{
"id": "def-public.RenderCompleteListener.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.RenderCompleteListener.Unnamed.$1",
"type": "Object",
"label": "element",
"isRequired": true,
"signature": [
"HTMLElement"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_listener.ts",
"lineNumber": 12
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_listener.ts",
"lineNumber": 12
}
},
{
"id": "def-public.RenderCompleteListener.destroy",
"type": "Function",
"children": [],
"signature": [
"() => void"
],
"description": [],
"label": "destroy",
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_listener.ts",
"lineNumber": 16
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.RenderCompleteListener.setup",
"type": "Function",
"children": [],
"signature": [
"() => void"
],
"description": [],
"label": "setup",
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_listener.ts",
"lineNumber": 21
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.RenderCompleteListener.disable",
"type": "Function",
"children": [],
"signature": [
"() => void"
],
"description": [],
"label": "disable",
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_listener.ts",
"lineNumber": 27
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_listener.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-public.ResizeChecker",
"type": "Class",
"tags": [],
"label": "ResizeChecker",
"description": [
"\n ResizeChecker receives an element and emits a \"resize\" event every time it changes size."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.ResizeChecker",
"text": "ResizeChecker"
},
" extends ",
"EventEmitter"
],
"children": [
{
"id": "def-public.ResizeChecker.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.ResizeChecker.Unnamed.$1",
"type": "Object",
"label": "el",
"isRequired": true,
"signature": [
"HTMLElement"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 26
}
},
{
"id": "def-public.ResizeChecker.Unnamed.$2.args",
"type": "Object",
"label": "args",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.ResizeChecker.Unnamed.$2.args.disabled",
"type": "CompoundType",
"label": "disabled",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 26
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 26
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 26
}
},
{
"id": "def-public.ResizeChecker.enable",
"type": "Function",
"label": "enable",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 51
}
},
{
"id": "def-public.ResizeChecker.modifySizeWithoutTriggeringResize",
"type": "Function",
"label": "modifySizeWithoutTriggeringResize",
"signature": [
"(block: () => void) => void"
],
"description": [
"\n Run a function and ignore all resizes that occur\n while it's running."
],
"children": [
{
"id": "def-public.ResizeChecker.modifySizeWithoutTriggeringResize.$1",
"type": "Function",
"label": "block",
"isRequired": true,
"signature": [
"() => void"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 68
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 68
}
},
{
"id": "def-public.ResizeChecker.destroy",
"type": "Function",
"label": "destroy",
"signature": [
"() => void"
],
"description": [
"\nTell the ResizeChecker to shutdown, stop listenings, and never\nemit another resize event.\n\nCleans up it's listeners and timers."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 84
}
}
],
"source": {
"path": "src/plugins/kibana_utils/public/resize_checker/resize_checker.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"id": "def-public.SavedFieldNotFound",
"type": "Class",
"tags": [],
"label": "SavedFieldNotFound",
"description": [
"\nA saved field doesn't exist anymore"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedFieldNotFound",
"text": "SavedFieldNotFound"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-public.SavedFieldNotFound.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.SavedFieldNotFound.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 54
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 54
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 53
},
"initialIsOpen": false
},
{
"id": "def-public.SavedFieldTypeInvalidForAgg",
"type": "Class",
"tags": [],
"label": "SavedFieldTypeInvalidForAgg",
"description": [
"\nA saved field type isn't compatible with aggregation"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedFieldTypeInvalidForAgg",
"text": "SavedFieldTypeInvalidForAgg"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-public.SavedFieldTypeInvalidForAgg.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.SavedFieldTypeInvalidForAgg.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 63
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 63
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 62
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectNotFound",
"type": "Class",
"tags": [],
"label": "SavedObjectNotFound",
"description": [
"\nA saved object was not found"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedObjectNotFound",
"text": "SavedObjectNotFound"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectNotFound.savedObjectType",
"type": "string",
"label": "savedObjectType",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-public.SavedObjectNotFound.savedObjectId",
"type": "string",
"label": "savedObjectId",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 34
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.SavedObjectNotFound.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.SavedObjectNotFound.Unnamed.$1",
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
},
{
"id": "def-public.SavedObjectNotFound.Unnamed.$2",
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
},
{
"id": "def-public.SavedObjectNotFound.Unnamed.$3",
"type": "string",
"label": "link",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
},
{
"id": "def-public.SavedObjectNotFound.Unnamed.$4",
"type": "string",
"label": "customMessage",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 32
},
"initialIsOpen": false
},
{
"id": "def-public.Storage",
"type": "Class",
"tags": [],
"label": "Storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
" implements ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorageWrapper",
"text": "IStorageWrapper"
},
"<any, void>"
],
"children": [
{
"tags": [],
"id": "def-public.Storage.store",
"type": "Object",
"label": "store",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 12
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorage",
"text": "IStorage"
},
"<any, void>"
]
},
{
"id": "def-public.Storage.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.Storage.Unnamed.$1",
"type": "Object",
"label": "store",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorage",
"text": "IStorage"
},
"<any, void>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 14
}
},
{
"id": "def-public.Storage.get",
"type": "Function",
"children": [
{
"id": "def-public.Storage.get.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 18
}
}
],
"signature": [
"(key: string) => any"
],
"description": [],
"label": "get",
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 18
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.Storage.set",
"type": "Function",
"children": [
{
"id": "def-public.Storage.set.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 35
}
},
{
"id": "def-public.Storage.set.$2",
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 35
}
}
],
"signature": [
"(key: string, value: any) => false | void"
],
"description": [],
"label": "set",
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 35
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.Storage.remove",
"type": "Function",
"children": [
{
"id": "def-public.Storage.remove.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 43
}
}
],
"signature": [
"(key: string) => any"
],
"description": [],
"label": "remove",
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 43
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.Storage.clear",
"type": "Function",
"children": [],
"signature": [
"() => void"
],
"description": [],
"label": "clear",
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 47
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/kibana_utils/public/storage/storage.ts",
"lineNumber": 11
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-public.abortSignalToPromise",
"type": "Function",
"label": "abortSignalToPromise",
"signature": [
"(signal: AbortSignal) => { promise: Promise<never>; cleanup: () => void; }"
],
"description": [
"\nReturns a `Promise` corresponding with when the given `AbortSignal` is aborted. Useful for\nsituations when you might need to `Promise.race` multiple `AbortSignal`s, or an `AbortSignal`\nwith any other expected errors (or completions).\n"
],
"children": [
{
"id": "def-public.abortSignalToPromise.$1",
"type": "Object",
"label": "signal",
"isRequired": true,
"signature": [
"AbortSignal"
],
"description": [
"The `AbortSignal` to generate the `Promise` from"
],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 28
},
"initialIsOpen": false
},
{
"id": "def-public.applyDiff",
"type": "Function",
"label": "applyDiff",
"signature": [
"(target: Record<string, any>, source: Record<string, any>) => ",
"IDiffObject"
],
"description": [],
"children": [
{
"id": "def-public.applyDiff.$1",
"type": "Object",
"label": "target",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/utils/diff_object.ts",
"lineNumber": 31
}
},
{
"id": "def-public.applyDiff.$2",
"type": "Object",
"label": "source",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/utils/diff_object.ts",
"lineNumber": 31
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/utils/diff_object.ts",
"lineNumber": 31
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.calculateObjectHash",
"type": "Function",
"label": "calculateObjectHash",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/calculate_object_hash.ts",
"lineNumber": 73
},
"signature": [
"typeof sum"
],
"initialIsOpen": false
},
{
"id": "def-public.createGetterSetter",
"type": "Function",
"children": [
{
"id": "def-public.createGetterSetter.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 12
}
}
],
"signature": [
"<T extends object>(name: string) => [",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Get",
"text": "Get"
},
"<T>, ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Set",
"text": "Set"
},
"<T>]"
],
"description": [],
"label": "createGetterSetter",
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.createHistoryObservable",
"type": "Function",
"label": "createHistoryObservable",
"signature": [
"(history: ",
"History",
"<any>) => ",
"Observable",
"<{ location: ",
"Location",
"<any>; action: ",
"Action",
"; }>"
],
"description": [
"\nConvert history.listen into an observable"
],
"children": [
{
"id": "def-public.createHistoryObservable.$1",
"type": "Object",
"label": "history",
"isRequired": true,
"signature": [
"History",
"<any>"
],
"description": [
"- {@link History} instance"
],
"source": {
"path": "src/plugins/kibana_utils/public/history/history_observable.ts",
"lineNumber": 22
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/history_observable.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-public.createKbnUrlControls",
"type": "Function",
"children": [
{
"id": "def-public.createKbnUrlControls.$1",
"type": "Object",
"label": "history",
"isRequired": true,
"signature": [
"History",
"<any>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 164
}
}
],
"signature": [
"(history?: ",
"History",
"<any>) => ",
"IKbnUrlControls"
],
"description": [],
"label": "createKbnUrlControls",
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 163
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.createKbnUrlStateStorage",
"type": "Function",
"children": [
{
"id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError",
"type": "Object",
"label": "{\n useHash = false,\n history,\n onGetError,\n onSetError,\n }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.useHash",
"type": "boolean",
"label": "useHash",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 65
}
},
{
"tags": [],
"id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.history",
"type": "Object",
"label": "history",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 66
},
"signature": [
"History",
"<any> | undefined"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.onGetError",
"type": "Function",
"label": "onGetError",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 67
},
"signature": [
"((error: Error) => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.onSetError",
"type": "Function",
"label": "onSetError",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 68
},
"signature": [
"((error: Error) => void) | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 64
}
}
],
"signature": [
"({ useHash, history, onGetError, onSetError, }?: { useHash: boolean; history?: ",
"History",
"<any> | undefined; onGetError?: ((error: Error) => void) | undefined; onSetError?: ((error: Error) => void) | undefined; }) => ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IKbnUrlStateStorage",
"text": "IKbnUrlStateStorage"
}
],
"description": [
"\nCreates {@link IKbnUrlStateStorage} state storage"
],
"label": "createKbnUrlStateStorage",
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 58
},
"tags": [
"public"
],
"returnComment": [
"- {@link IKbnUrlStateStorage}"
],
"initialIsOpen": false
},
{
"id": "def-public.createKbnUrlTracker",
"type": "Function",
"label": "createKbnUrlTracker",
"signature": [
"({\n baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}: { baseUrl: string; defaultSubUrl: string; stateParams: { kbnUrlKey: string; stateUpdate$: ",
"Observable",
"<unknown>; }[]; storageKey: string; navLinkUpdater$: ",
"BehaviorSubject",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.AppUpdater",
"text": "AppUpdater"
},
">; toastNotifications: Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ToastsApi",
"text": "ToastsApi"
},
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">; history?: ",
"History"
],
"description": [
"\nListens to history changes and optionally to global state changes and updates the nav link url of\na given app to point to the last visited page within the app.\n\nThis includes the following parts:\n* When the app is currently active, the nav link points to the configurable default url of the app.\n* When the app is not active the last visited url is set to the nav link.\n* When a provided observable emits a new value, the state parameter in the url of the nav link is updated\nas long as the app is not active."
],
"children": [
{
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink",
"type": "Object",
"label": "{\n baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.baseUrl",
"type": "string",
"label": "baseUrl",
"description": [
"\nBase url of the current app. This will be used as a prefix for the\nnav link in the side bar"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 65
}
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.defaultSubUrl",
"type": "string",
"label": "defaultSubUrl",
"description": [
"\nDefault sub url for this app. If the app is currently active or no sub url is already stored in session storage and the app hasn't been visited yet, the nav link will be set to this url."
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 69
}
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.stateParams",
"type": "Array",
"label": "stateParams",
"description": [
"\nList of URL mapped states that should get updated even when the app is not currently active"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 73
},
"signature": [
"{ kbnUrlKey: string; stateUpdate$: ",
"Observable",
"<unknown>; }[]"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.storageKey",
"type": "string",
"label": "storageKey",
"description": [
"\nKey used to store the current sub url in session storage. This key should only be used for one active url tracker at any given time."
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 86
}
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.navLinkUpdater$",
"type": "Object",
"label": "navLinkUpdater$",
"description": [
"\nApp updater subject passed into the application definition to change nav link url."
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 90
},
"signature": [
"BehaviorSubject",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.AppUpdater",
"text": "AppUpdater"
},
">"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.toastNotifications",
"type": "Object",
"label": "toastNotifications",
"description": [
"\nToast notifications service to show toasts in error cases."
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 94
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ToastsApi",
"text": "ToastsApi"
},
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.history",
"type": "Object",
"label": "history",
"description": [
"\nHistory object to use to track url changes. If this isn't provided, a local history instance will be created."
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 98
},
"signature": [
"History",
"<any> | undefined"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.getHistory",
"type": "Function",
"label": "getHistory",
"description": [
"\nLazily retrieve history instance"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 103
},
"signature": [
"(() => ",
"History",
"<any>) | undefined"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.storage",
"type": "Object",
"label": "storage",
"description": [
"\nStorage object to use to persist currently active url. If this isn't provided, the browser wide session storage instance will be used."
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 108
},
"signature": [
"Storage | undefined"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.shouldTrackUrlUpdate",
"type": "Function",
"label": "shouldTrackUrlUpdate",
"description": [
"\nChecks if pathname belongs to current app. It's used in history listener to define whether it's necessary to set pathname as active url or not.\nThe default implementation compares the app name to the first part of pathname. Consumers can override this function for more complex cases.\n"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 115
},
"signature": [
"((pathname: string) => boolean) | undefined"
]
},
{
"tags": [],
"id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.onBeforeNavLinkSaved",
"type": "Function",
"label": "onBeforeNavLinkSaved",
"description": [
"\nCalled when current subpath is about to be saved to sessionStorage for subsequent use as a nav link.\nUse to mutate app's subpath before it is saved by returning a new subpath."
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 121
},
"signature": [
"((newNavLink: string) => string) | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 60
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts",
"lineNumber": 46
},
"initialIsOpen": false
},
{
"id": "def-public.createQueryParamObservable",
"type": "Function",
"label": "createQueryParamObservable",
"signature": [
"(history: ",
"History",
"<any>, paramKey: string) => ",
"Observable",
"<Param | null>"
],
"description": [
"\nCreate an observable that emits every time _paramKey_ changes"
],
"children": [
{
"id": "def-public.createQueryParamObservable.$1",
"type": "Object",
"label": "history",
"isRequired": true,
"signature": [
"History",
"<any>"
],
"description": [
"- {@link History} instance"
],
"source": {
"path": "src/plugins/kibana_utils/public/history/history_observable.ts",
"lineNumber": 50
}
},
{
"id": "def-public.createQueryParamObservable.$2",
"type": "string",
"label": "paramKey",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- query param key to observe"
],
"source": {
"path": "src/plugins/kibana_utils/public/history/history_observable.ts",
"lineNumber": 51
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/history_observable.ts",
"lineNumber": 49
},
"initialIsOpen": false
},
{
"id": "def-public.createQueryParamsObservable",
"type": "Function",
"label": "createQueryParamsObservable",
"signature": [
"(history: ",
"History",
"<any>) => ",
"Observable",
"<",
"ParsedQuery",
"<string>>"
],
"description": [
"\nCreate an observable that emits every time any of query params change.\nUses deepEqual check."
],
"children": [
{
"id": "def-public.createQueryParamsObservable.$1",
"type": "Object",
"label": "history",
"isRequired": true,
"signature": [
"History",
"<any>"
],
"description": [
"- {@link History} instance"
],
"source": {
"path": "src/plugins/kibana_utils/public/history/history_observable.ts",
"lineNumber": 37
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/history_observable.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-public.createSessionStorageStateStorage",
"type": "Function",
"children": [
{
"id": "def-public.createSessionStorageStateStorage.$1",
"type": "Object",
"label": "storage",
"isRequired": true,
"signature": [
"Storage"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts",
"lineNumber": 29
}
}
],
"signature": [
"(storage?: Storage) => ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.ISessionStorageStateStorage",
"text": "ISessionStorageStateStorage"
}
],
"description": [
"\nCreates {@link ISessionStorageStateStorage}\n{@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md | guide}"
],
"label": "createSessionStorageStateStorage",
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts",
"lineNumber": 28
},
"tags": [
"public"
],
"returnComment": [
"- {@link ISessionStorageStateStorage}"
],
"initialIsOpen": false
},
{
"id": "def-public.createStartServicesGetter",
"type": "Function",
"children": [
{
"id": "def-public.createStartServicesGetter.$1",
"type": "Function",
"label": "accessor",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.StartServicesAccessor",
"text": "StartServicesAccessor"
},
"<TPluginsStart, TStart>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts",
"lineNumber": 66
}
}
],
"signature": [
"<TPluginsStart extends object, TStart>(accessor: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.StartServicesAccessor",
"text": "StartServicesAccessor"
},
"<TPluginsStart, TStart>) => ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.StartServicesGetter",
"text": "StartServicesGetter"
},
"<TPluginsStart, TStart, ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
">"
],
"description": [
"\nUse this utility to create a synchronous *start* service getter in *setup*\nlife-cycle of your plugin.\n\nBelow is a usage example in a Kibana plugin.\n\n```ts\nexport interface MyPluginStartDeps {\n data: DataPublicPluginStart;\n expressions: ExpressionsStart;\n inspector: InspectorStart;\n uiActions: UiActionsStart;\n}\n\nclass MyPlugin implements Plugin {\n setup(core: CoreSetup<MyPluginStartDeps>, plugins) {\n const start = createStartServicesGetter(core.getStartServices);\n plugins.expressions.registerFunction(myExpressionFunction(start));\n }\n\n start(core, plugins: MyPluginStartDeps) {\n\n }\n}\n```\n\nIn `myExpressionFunction` you can make sure you are picking only the dependencies\nyour function needs using the `Pick` type.\n\n```ts\nconst myExpressionFunction =\n (start: StartServicesGetter<Pick<MyPluginStartDeps, 'data'>>) => {\n\n start().plugins.indexPatterns.something(123);\n}\n```\n"
],
"label": "createStartServicesGetter",
"source": {
"path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts",
"lineNumber": 65
},
"tags": [],
"returnComment": [
"Returns a function which synchronously returns *start* core services\nand plugin contracts. If you call this function before the *start* life-cycle\nhas started it will throw."
],
"initialIsOpen": false
},
{
"id": "def-public.createStateContainer",
"type": "Function",
"label": "createStateContainer",
"signature": [
"(defaultState: State) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, {}, {}>"
],
"description": [
"\nCreates a state container without transitions and without selectors."
],
"children": [
{
"id": "def-public.createStateContainer.$1",
"type": "Uncategorized",
"label": "defaultState",
"isRequired": true,
"signature": [
"State"
],
"description": [
"- initial state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 64
}
}
],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 63
},
"initialIsOpen": false
},
{
"id": "def-public.createStateContainer",
"type": "Function",
"label": "createStateContainer",
"signature": [
"(defaultState: State, pureTransitions: PureTransitions) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, PureTransitions, {}>"
],
"description": [
"\nCreates a state container with transitions, but without selectors."
],
"children": [
{
"id": "def-public.createStateContainer.$1",
"type": "Uncategorized",
"label": "defaultState",
"isRequired": true,
"signature": [
"State"
],
"description": [
"- initial state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 74
}
},
{
"id": "def-public.createStateContainer.$2",
"type": "Uncategorized",
"label": "pureTransitions",
"isRequired": true,
"signature": [
"PureTransitions"
],
"description": [
"- state transitions configuration object. Map of {@link PureTransition}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 75
}
}
],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 73
},
"initialIsOpen": false
},
{
"id": "def-public.createStateContainer",
"type": "Function",
"label": "createStateContainer",
"signature": [
"(defaultState: State, pureTransitions: PureTransitions, pureSelectors: PureSelectors, options: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.CreateStateContainerOptions",
"text": "CreateStateContainerOptions"
},
" | undefined) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, PureTransitions, PureSelectors>"
],
"description": [
"\nCreates a state container with transitions and selectors."
],
"children": [
{
"id": "def-public.createStateContainer.$1",
"type": "Uncategorized",
"label": "defaultState",
"isRequired": true,
"signature": [
"State"
],
"description": [
"- initial state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 92
}
},
{
"id": "def-public.createStateContainer.$2",
"type": "Uncategorized",
"label": "pureTransitions",
"isRequired": true,
"signature": [
"PureTransitions"
],
"description": [
"- state transitions configuration object. Map of {@link PureTransition}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 93
}
},
{
"id": "def-public.createStateContainer.$3",
"type": "Uncategorized",
"label": "pureSelectors",
"isRequired": true,
"signature": [
"PureSelectors"
],
"description": [
"- state selectors configuration object. Map of {@link PureSelectors}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 94
}
},
{
"id": "def-public.createStateContainer.$4",
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.CreateStateContainerOptions",
"text": "CreateStateContainerOptions"
},
" | undefined"
],
"description": [
"- state container options {@link CreateStateContainerOptions}"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 95
}
}
],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 87
},
"initialIsOpen": false
},
{
"id": "def-public.createStateContainerReactHelpers",
"type": "Function",
"children": [],
"signature": [
"<Container extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<any, any, {}>>() => { Provider: React.Provider<Container>; Consumer: React.Consumer<Container>; context: React.Context<Container>; useContainer: () => Container; useState: () => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>; useTransitions: () => Container[\"transitions\"]; useSelector: <Result>(selector: (state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>) => Result, comparator?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Comparator",
"text": "Comparator"
},
"<Result>) => Result; connect: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Connect",
"text": "Connect"
}
],
"description": [
"\nCreates helpers for using {@link StateContainer | State Containers} with react\nRefer to {@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_containers/react.md | guide} for details"
],
"label": "createStateContainerReactHelpers",
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 69
},
"tags": [
"public"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.createStateHash",
"type": "Function",
"label": "createStateHash",
"signature": [
"(json: string, existingJsonProvider: ((hash: string) => string | null) | undefined) => string"
],
"description": [],
"children": [
{
"id": "def-public.createStateHash.$1",
"type": "string",
"label": "json",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 17
}
},
{
"id": "def-public.createStateHash.$2",
"type": "Function",
"label": "existingJsonProvider",
"isRequired": false,
"signature": [
"((hash: string) => string | null) | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-public.createUrlTracker",
"type": "Function",
"label": "createUrlTracker",
"signature": [
"(key: string, storage: Storage) => ",
"IUrlTracker"
],
"description": [
"\nReplicates what src/legacy/ui/public/chrome/api/nav.ts did\nPersists the url in sessionStorage so it could be restored if navigated back to the app"
],
"children": [
{
"id": "def-public.createUrlTracker.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/url_tracker.ts",
"lineNumber": 21
}
},
{
"id": "def-public.createUrlTracker.$2",
"type": "Object",
"label": "storage",
"isRequired": true,
"signature": [
"Storage"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/url_tracker.ts",
"lineNumber": 21
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/url_tracker.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-public.defer",
"type": "Function",
"children": [],
"signature": [
"<T>() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Defer",
"text": "Defer"
},
"<T>"
],
"description": [],
"label": "defer",
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 30
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.dispatchRenderComplete",
"type": "Function",
"label": "dispatchRenderComplete",
"signature": [
"(el: HTMLElement) => void"
],
"description": [],
"children": [
{
"id": "def-public.dispatchRenderComplete.$1",
"type": "Object",
"label": "el",
"isRequired": true,
"signature": [
"HTMLElement"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 13
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-public.dispatchRenderStart",
"type": "Function",
"label": "dispatchRenderStart",
"signature": [
"(el: HTMLElement) => void"
],
"description": [],
"children": [
{
"id": "def-public.dispatchRenderStart.$1",
"type": "Object",
"label": "el",
"isRequired": true,
"signature": [
"HTMLElement"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 17
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/render_complete/render_complete_dispatcher.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-public.fieldWildcardFilter",
"type": "Function",
"label": "fieldWildcardFilter",
"signature": [
"(globs: string[], metaFields: string[]) => (val: unknown) => boolean"
],
"description": [],
"children": [
{
"id": "def-public.fieldWildcardFilter.$1",
"type": "Array",
"label": "globs",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
}
},
{
"id": "def-public.fieldWildcardFilter.$2",
"type": "Array",
"label": "metaFields",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
},
"initialIsOpen": false
},
{
"id": "def-public.fieldWildcardMatcher",
"type": "Function",
"label": "fieldWildcardMatcher",
"signature": [
"(globs: string[], metaFields: unknown[]) => (val: unknown) => boolean"
],
"description": [],
"children": [
{
"id": "def-public.fieldWildcardMatcher.$1",
"type": "Array",
"label": "globs",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
}
},
{
"id": "def-public.fieldWildcardMatcher.$2",
"type": "Array",
"label": "metaFields",
"isRequired": true,
"signature": [
"unknown[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-public.getQueryParams",
"type": "Function",
"label": "getQueryParams",
"signature": [
"(location: ",
"Location",
"<any>) => ",
"ParsedQuery",
"<string>"
],
"description": [],
"children": [
{
"id": "def-public.getQueryParams.$1",
"type": "Object",
"label": "location",
"isRequired": true,
"signature": [
"Location",
"<any>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/get_query_params.ts",
"lineNumber": 12
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/get_query_params.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-public.getStateFromKbnUrl",
"type": "Function",
"label": "getStateFromKbnUrl",
"signature": [
"(key: string, url: string, { getFromHashQuery = true }: { getFromHashQuery: boolean; }) => State | null"
],
"description": [
"\nRetrieves specific state from url by key\ne.g.:\n\ngiven an url:\nhttp://localhost:5601/oxf/app/kibana#/yourApp?_a=(tab:indexedFields)&_b=(f:test,i:'',l:'')\nand key '_a'\nwill return object:\n{tab: 'indexedFields'}\n\n\nBy default due to Kibana legacy reasons assumed that state is stored in a query inside a hash part of the URL:\nhttp://localhost:5601/oxf/app/kibana#/yourApp?_a={STATE}\n\n{ getFromHashQuery: false } option should be used in case state is stored in a main query (not in a hash):\nhttp://localhost:5601/oxf/app/kibana?_a={STATE}#/yourApp"
],
"children": [
{
"id": "def-public.getStateFromKbnUrl.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 71
}
},
{
"id": "def-public.getStateFromKbnUrl.$2",
"type": "string",
"label": "url",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 72
}
},
{
"id": "def-public.getStateFromKbnUrl.$3.getFromHashQuerytrue",
"type": "Object",
"label": "{ getFromHashQuery = true }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.getStateFromKbnUrl.$3.getFromHashQuerytrue.getFromHashQuery",
"type": "boolean",
"label": "getFromHashQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 73
}
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 73
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 70
},
"initialIsOpen": false
},
{
"id": "def-public.getStatesFromKbnUrl",
"type": "Function",
"label": "getStatesFromKbnUrl",
"signature": [
"(url: string, keys: (keyof State)[] | undefined, { getFromHashQuery = true }: { getFromHashQuery: boolean; }) => State"
],
"description": [
"\nParses a kibana url and retrieves all the states encoded into the URL,\nHandles both expanded rison state and hashed state (where the actual state stored in sessionStorage)\ne.g.:\n\ngiven an url:\nhttp://localhost:5601/oxf/app/kibana#/yourApp?_a=(tab:indexedFields)&_b=(f:test,i:'',l:'')\nwill return object:\n{_a: {tab: 'indexedFields'}, _b: {f: 'test', i: '', l: ''}};\n\n\nBy default due to Kibana legacy reasons assumed that state is stored in a query inside a hash part of the URL:\nhttp://localhost:5601/oxf/app/kibana#/yourApp?_a={STATE}\n\n{ getFromHashQuery: false } option should be used in case state is stored in a main query (not in a hash):\nhttp://localhost:5601/oxf/app/kibana?_a={STATE}#/yourApp\n"
],
"children": [
{
"id": "def-public.getStatesFromKbnUrl.$1",
"type": "string",
"label": "url",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 36
}
},
{
"id": "def-public.getStatesFromKbnUrl.$2",
"type": "Array",
"label": "keys",
"isRequired": false,
"signature": [
"(keyof State)[] | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 37
}
},
{
"id": "def-public.getStatesFromKbnUrl.$3.getFromHashQuerytrue",
"type": "Object",
"label": "{ getFromHashQuery = true }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.getStatesFromKbnUrl.$3.getFromHashQuerytrue.getFromHashQuery",
"type": "boolean",
"label": "getFromHashQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 38
}
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 38
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 35
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.hashQuery",
"type": "Function",
"label": "hashQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/hash_unhash_url.ts",
"lineNumber": 20
},
"signature": [
"(query: Record<string, any>, options?: IUrlQueryMapperOptions) => { [k: string]: any; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.hashUrl",
"type": "Function",
"label": "hashUrl",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/hash_unhash_url.ts",
"lineNumber": 23
},
"signature": [
"(url: string) => string"
],
"initialIsOpen": false
},
{
"id": "def-public.isStateHash",
"type": "Function",
"label": "isStateHash",
"signature": [
"(str: string) => boolean"
],
"description": [],
"children": [
{
"id": "def-public.isStateHash.$1",
"type": "string",
"label": "str",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 42
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 42
},
"initialIsOpen": false
},
{
"id": "def-public.of",
"type": "Function",
"children": [
{
"id": "def-public.of.$1",
"type": "Object",
"label": "promise",
"isRequired": true,
"signature": [
"Promise<T>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/of.ts",
"lineNumber": 19
}
}
],
"signature": [
"<T, E = any>(promise: Promise<T>) => Promise<[T | undefined, E | undefined, boolean]>"
],
"description": [
"\nGiven a promise awaits it and returns a 3-tuple, with the following members:\n\n- First entry is either the resolved value of the promise or `undefined`.\n- Second entry is either the error thrown by promise or `undefined`.\n- Third entry is a boolean, truthy if promise was resolved and falsy if rejected.\n"
],
"label": "of",
"source": {
"path": "src/plugins/kibana_utils/common/of.ts",
"lineNumber": 18
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.persistState",
"type": "Function",
"label": "persistState",
"signature": [
"(state: State) => string"
],
"description": [],
"children": [
{
"id": "def-public.persistState.$1",
"type": "Uncategorized",
"label": "state",
"isRequired": true,
"signature": [
"State"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 66
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 66
},
"initialIsOpen": false
},
{
"id": "def-public.redirectWhenMissing",
"type": "Function",
"label": "redirectWhenMissing",
"signature": [
"({\n history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}: { history: ",
"History",
"<any>; navigateToApp: (appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined) => Promise<void>; basePath: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.IBasePath",
"text": "IBasePath"
},
"; mapping: string | Mapping; toastNotifications: Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ToastsApi",
"text": "ToastsApi"
},
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">; onBeforeRedirect?: ((error: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedObjectNotFound",
"text": "SavedObjectNotFound"
}
],
"description": [
"\nCreates an error handler that will redirect to a url when a SavedObjectNotFound\nerror is thrown"
],
"children": [
{
"id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect",
"type": "Object",
"label": "{\n history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.history",
"type": "Object",
"label": "history",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 49
},
"signature": [
"History",
"<any>"
]
},
{
"tags": [],
"id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.navigateToApp",
"type": "Function",
"label": "navigateToApp",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 50
},
"signature": [
"(appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined) => Promise<void>"
]
},
{
"tags": [],
"id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.basePath",
"type": "Object",
"label": "basePath",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 51
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.IBasePath",
"text": "IBasePath"
}
]
},
{
"tags": [],
"id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.mapping",
"type": "CompoundType",
"label": "mapping",
"description": [
"\na mapping of url's to redirect to based on the saved object that\ncouldn't be found, or just a string that will be used for all types"
],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 56
},
"signature": [
"string | Mapping"
]
},
{
"tags": [],
"id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.toastNotifications",
"type": "Object",
"label": "toastNotifications",
"description": [
"\nToast notifications service to show toasts in error cases."
],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 60
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ToastsApi",
"text": "ToastsApi"
},
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"
]
},
{
"tags": [],
"id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.onBeforeRedirect",
"type": "Function",
"label": "onBeforeRedirect",
"description": [
"\nOptional callback invoked directly before a redirect is triggered"
],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 64
},
"signature": [
"((error: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedObjectNotFound",
"text": "SavedObjectNotFound"
},
") => void) | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 48
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-public.removeQueryParam",
"type": "Function",
"label": "removeQueryParam",
"signature": [
"(history: ",
"History",
"<any>, param: string, replace: boolean) => void"
],
"description": [],
"children": [
{
"id": "def-public.removeQueryParam.$1",
"type": "Object",
"label": "history",
"isRequired": true,
"signature": [
"History",
"<any>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/remove_query_param.ts",
"lineNumber": 14
}
},
{
"id": "def-public.removeQueryParam.$2",
"type": "string",
"label": "param",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/remove_query_param.ts",
"lineNumber": 14
}
},
{
"id": "def-public.removeQueryParam.$3",
"type": "boolean",
"label": "replace",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/remove_query_param.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/history/remove_query_param.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-public.replaceUrlHashQuery",
"type": "Function",
"label": "replaceUrlHashQuery",
"signature": [
"(rawUrl: string, queryReplacer: (query: ",
"ParsedQuery",
"<string>) => ",
"ParsedQuery",
"<string>) => string"
],
"description": [],
"children": [
{
"id": "def-public.replaceUrlHashQuery.$1",
"type": "string",
"label": "rawUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/format.ts",
"lineNumber": 35
}
},
{
"id": "def-public.replaceUrlHashQuery.$2",
"type": "Function",
"label": "queryReplacer",
"isRequired": true,
"signature": [
"(query: ",
"ParsedQuery",
"<string>) => ",
"ParsedQuery",
"<string>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/format.ts",
"lineNumber": 36
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/format.ts",
"lineNumber": 34
},
"initialIsOpen": false
},
{
"id": "def-public.replaceUrlQuery",
"type": "Function",
"label": "replaceUrlQuery",
"signature": [
"(rawUrl: string, queryReplacer: (query: ",
"ParsedQuery",
"<string>) => ",
"ParsedQuery",
"<string>) => string"
],
"description": [],
"children": [
{
"id": "def-public.replaceUrlQuery.$1",
"type": "string",
"label": "rawUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/format.ts",
"lineNumber": 15
}
},
{
"id": "def-public.replaceUrlQuery.$2",
"type": "Function",
"label": "queryReplacer",
"isRequired": true,
"signature": [
"(query: ",
"ParsedQuery",
"<string>) => ",
"ParsedQuery",
"<string>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/format.ts",
"lineNumber": 16
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/format.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-public.retrieveState",
"type": "Function",
"label": "retrieveState",
"signature": [
"(stateHash: string) => State"
],
"description": [],
"children": [
{
"id": "def-public.retrieveState.$1",
"type": "string",
"label": "stateHash",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 46
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/state_hash/state_hash.ts",
"lineNumber": 46
},
"initialIsOpen": false
},
{
"id": "def-public.setStateToKbnUrl",
"type": "Function",
"label": "setStateToKbnUrl",
"signature": [
"(key: string, state: State, { useHash = false, storeInHashQuery = true }: { useHash: boolean; storeInHashQuery?: boolean | undefined; }, rawUrl: string) => string"
],
"description": [
"\nSets state to the url by key and returns a new url string.\nDoesn't actually updates history\n\ne.g.:\ngiven a url: http://localhost:5601/oxf/app/kibana#/yourApp?_a=(tab:indexedFields)&_b=(f:test,i:'',l:'')\nkey: '_a'\nand state: {tab: 'other'}\n\nwill return url:\nhttp://localhost:5601/oxf/app/kibana#/yourApp?_a=(tab:other)&_b=(f:test,i:'',l:'')\n\nBy default due to Kibana legacy reasons assumed that state is stored in a query inside a hash part of the URL:\nhttp://localhost:5601/oxf/app/kibana#/yourApp?_a={STATE}\n\n{ storeInHashQuery: false } option should be used in you want to store you state in a main query (not in a hash):\nhttp://localhost:5601/oxf/app/kibana?_a={STATE}#/yourApp"
],
"children": [
{
"id": "def-public.setStateToKbnUrl.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 97
}
},
{
"id": "def-public.setStateToKbnUrl.$2",
"type": "Uncategorized",
"label": "state",
"isRequired": true,
"signature": [
"State"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 98
}
},
{
"id": "def-public.setStateToKbnUrl.$3.useHashfalsestoreInHashQuerytrue",
"type": "Object",
"label": "{ useHash = false, storeInHashQuery = true }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.setStateToKbnUrl.$3.useHashfalsestoreInHashQuerytrue.useHash",
"type": "boolean",
"label": "useHash",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 99
}
},
{
"tags": [],
"id": "def-public.setStateToKbnUrl.$3.useHashfalsestoreInHashQuerytrue.storeInHashQuery",
"type": "CompoundType",
"label": "storeInHashQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 99
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 99
}
},
{
"id": "def-public.setStateToKbnUrl.$4",
"type": "string",
"label": "rawUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 103
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts",
"lineNumber": 96
},
"initialIsOpen": false
},
{
"id": "def-public.syncState",
"type": "Function",
"label": "syncState",
"signature": [
"({\n storageKey,\n stateStorage,\n stateContainer,\n}: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStateSyncConfig",
"text": "IStateSyncConfig"
},
"<State, ",
"IStateStorage",
">) => ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.ISyncStateRef",
"text": "ISyncStateRef"
},
"<",
"IStateStorage",
">"
],
"description": [
"\nUtility for syncing application state wrapped in state container\nwith some kind of storage (e.g. URL)\n\nGo {@link https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync | here} for a complete guide and examples.\n"
],
"children": [
{
"id": "def-public.syncState.$1",
"type": "Object",
"label": "{\n storageKey,\n stateStorage,\n stateContainer,\n}",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStateSyncConfig",
"text": "IStateSyncConfig"
},
"<State, ",
"IStateStorage",
">"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 110
}
}
],
"tags": [
"public"
],
"returnComment": [
"- {@link ISyncStateRef}"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 107
},
"initialIsOpen": false
},
{
"id": "def-public.syncStates",
"type": "Function",
"label": "syncStates",
"signature": [
"(stateSyncConfigs: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStateSyncConfig",
"text": "IStateSyncConfig"
},
"<any, ",
"IStateStorage",
">[]) => ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.ISyncStateRef",
"text": "ISyncStateRef"
},
"<",
"IStateStorage",
">"
],
"description": [],
"children": [
{
"id": "def-public.syncStates.$1",
"type": "Array",
"label": "stateSyncConfigs",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStateSyncConfig",
"text": "IStateSyncConfig"
},
"<any, ",
"IStateStorage",
">[]"
],
"description": [
"- Array of {@link IStateSyncConfig} to sync"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 196
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 196
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.unhashQuery",
"type": "Function",
"label": "unhashQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/hash_unhash_url.ts",
"lineNumber": 19
},
"signature": [
"(query: Record<string, any>, options?: IUrlQueryMapperOptions) => { [k: string]: any; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.unhashUrl",
"type": "Function",
"label": "unhashUrl",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/hash_unhash_url.ts",
"lineNumber": 22
},
"signature": [
"(url: string) => string"
],
"initialIsOpen": false
},
{
"id": "def-public.useContainerSelector",
"type": "Function",
"children": [
{
"id": "def-public.useContainerSelector.$1",
"type": "Uncategorized",
"label": "container",
"isRequired": true,
"signature": [
"Container"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 40
}
},
{
"id": "def-public.useContainerSelector.$2",
"type": "Function",
"label": "selector",
"isRequired": true,
"signature": [
"(state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>) => Result"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 41
}
},
{
"id": "def-public.useContainerSelector.$3",
"type": "Function",
"label": "comparator",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Comparator",
"text": "Comparator"
},
"<Result>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 42
}
}
],
"signature": [
"<Container extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<any, any, {}>, Result>(container: Container, selector: (state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>) => Result, comparator?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Comparator",
"text": "Comparator"
},
"<Result>) => Result"
],
"description": [
"\nReact hook to apply selector to state container to extract only needed information. Will\nre-render your component only when the section changes.\n"
],
"label": "useContainerSelector",
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 39
},
"tags": [
"public"
],
"returnComment": [
"- result of a selector(state)"
],
"initialIsOpen": false
},
{
"id": "def-public.useContainerState",
"type": "Function",
"children": [
{
"id": "def-public.useContainerState.$1",
"type": "Uncategorized",
"label": "container",
"isRequired": true,
"signature": [
"Container"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 24
}
}
],
"signature": [
"<Container extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<any, any, {}>>(container: Container) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>"
],
"description": [
"\nReact hooks that returns the latest state of a {@link StateContainer}.\n"
],
"label": "useContainerState",
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 23
},
"tags": [
"public"
],
"returnComment": [
"- latest {@link StateContainer} state"
],
"initialIsOpen": false
},
{
"id": "def-public.withNotifyOnErrors",
"type": "Function",
"children": [
{
"id": "def-public.withNotifyOnErrors.$1",
"type": "Object",
"label": "toasts",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ToastsApi",
"text": "ToastsApi"
},
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/errors.ts",
"lineNumber": 38
}
}
],
"signature": [
"(toasts: Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ToastsApi",
"text": "ToastsApi"
},
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">) => { onGetError: (error: Error) => void; onSetError: (error: Error) => void; }"
],
"description": [
"\nHelper for configuring {@link IKbnUrlStateStorage} to notify about inner errors\n"
],
"label": "withNotifyOnErrors",
"source": {
"path": "src/plugins/kibana_utils/public/state_management/url/errors.ts",
"lineNumber": 38
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.BaseStateContainer",
"type": "Interface",
"label": "BaseStateContainer",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<State>"
],
"description": [
"\nBase state container shape without transitions or selectors"
],
"tags": [
"public"
],
"children": [
{
"tags": [
"public"
],
"id": "def-public.BaseStateContainer.get",
"type": "Function",
"label": "get",
"description": [
"\nRetrieves current state from the container"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 62
},
"signature": [
"() => State"
]
},
{
"tags": [],
"id": "def-public.BaseStateContainer.set",
"type": "Function",
"label": "set",
"description": [
"\nSets state into container"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 67
},
"signature": [
"(state: State) => void"
]
},
{
"tags": [],
"id": "def-public.BaseStateContainer.state$",
"type": "Object",
"label": "state$",
"description": [
"\n{@link Observable} of state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 71
},
"signature": [
"Observable",
"<State>"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 56
},
"initialIsOpen": false
},
{
"id": "def-public.CollectConfigProps",
"type": "Interface",
"label": "CollectConfigProps",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.CollectConfigProps",
"text": "CollectConfigProps"
},
"<Config, Context>"
],
"description": [
"\nProps provided to `CollectConfig` component on every re-render."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CollectConfigProps.config",
"type": "Uncategorized",
"label": "config",
"description": [
"\nCurrent (latest) config of the item."
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 45
},
"signature": [
"Config"
]
},
{
"tags": [],
"id": "def-public.CollectConfigProps.onConfig",
"type": "Function",
"label": "onConfig",
"description": [
"\nCallback called when user updates the config in UI."
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 50
},
"signature": [
"(config: Config) => void"
]
},
{
"tags": [],
"id": "def-public.CollectConfigProps.context",
"type": "Uncategorized",
"label": "context",
"description": [
"\nContext information about where component is being rendered."
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 55
},
"signature": [
"Context"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 38
},
"initialIsOpen": false
},
{
"id": "def-public.Configurable",
"type": "Interface",
"label": "Configurable",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Configurable",
"text": "Configurable"
},
"<Config, Context>"
],
"description": [
"\nRepresents something that can be configured by user using UI."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Configurable.createConfig",
"type": "Function",
"label": "createConfig",
"description": [
"\nCreate default config for this item, used when item is created for the first time."
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 22
},
"signature": [
"(context: Context) => Config"
]
},
{
"tags": [],
"id": "def-public.Configurable.isConfigValid",
"type": "Function",
"label": "isConfigValid",
"description": [
"\nIs this config valid. Used to validate user's input before saving."
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 27
},
"signature": [
"(config: Config, context: Context) => boolean"
]
},
{
"tags": [],
"id": "def-public.Configurable.CollectConfig",
"type": "Function",
"label": "CollectConfig",
"description": [
"\n`UiComponent` to be rendered when collecting configuration for this item."
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 32
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponent",
"text": "UiComponent"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.CollectConfigProps",
"text": "CollectConfigProps"
},
"<Config, Context>>"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"lineNumber": 15
},
"initialIsOpen": false
},
{
"id": "def-public.CreateStateContainerOptions",
"type": "Interface",
"label": "CreateStateContainerOptions",
"description": [
"\nState container options"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.CreateStateContainerOptions.freeze",
"type": "Function",
"label": "freeze",
"description": [
"\nFunction to use when freezing state. Supply identity function.\nIf not provided, default `deepFreeze` is used.\n"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 54
},
"signature": [
"(<T>(state: T) => T) | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 40
},
"initialIsOpen": false
},
{
"id": "def-public.IKbnUrlStateStorage",
"type": "Interface",
"label": "IKbnUrlStateStorage",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IKbnUrlStateStorage",
"text": "IKbnUrlStateStorage"
},
" extends ",
"IStateStorage"
],
"description": [
"\nKbnUrlStateStorage is a state storage for {@link syncState} utility which:\n\n1. Keeps state in sync with the URL.\n2. Serializes data and stores it in the URL in one of the supported formats:\n * Rison encoded.\n * Hashed URL: In URL we store only the hash from the serialized state, but the state itself is stored in sessionStorage. See Kibana's `state:storeInSessionStorage` advanced option for more context.\n3. Takes care of listening to the URL updates and notifies state about the updates.\n4. Takes care of batching URL updates to prevent redundant browser history records.\n\n{@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md | Refer to this guide for more info}"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.IKbnUrlStateStorage.set",
"type": "Function",
"label": "set",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 34
},
"signature": [
"<State>(key: string, state: State, opts?: { replace: boolean; } | undefined) => Promise<string | undefined>"
]
},
{
"tags": [],
"id": "def-public.IKbnUrlStateStorage.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 39
},
"signature": [
"<State = unknown>(key: string) => State | null"
]
},
{
"tags": [],
"id": "def-public.IKbnUrlStateStorage.change$",
"type": "Function",
"label": "change$",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 40
},
"signature": [
"<State = unknown>(key: string) => ",
"Observable",
"<State | null>"
]
},
{
"tags": [],
"id": "def-public.IKbnUrlStateStorage.cancel",
"type": "Function",
"label": "cancel",
"description": [
"\nCancels any pending url updates"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 45
},
"signature": [
"() => void"
]
},
{
"tags": [],
"id": "def-public.IKbnUrlStateStorage.kbnUrlControls",
"type": "Object",
"label": "kbnUrlControls",
"description": [
"\nLower level wrapper around history library that handles batching multiple URL updates into one history change"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 50
},
"signature": [
"IKbnUrlControls"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"lineNumber": 33
},
"initialIsOpen": false
},
{
"id": "def-public.INullableBaseStateContainer",
"type": "Interface",
"label": "INullableBaseStateContainer",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.INullableBaseStateContainer",
"text": "INullableBaseStateContainer"
},
"<State> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<State>"
],
"description": [
"\nExtension of {@link BaseStateContainer} with one constraint: set state should handle `null` as incoming state"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.INullableBaseStateContainer.set",
"type": "Function",
"label": "set",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/types.ts",
"lineNumber": 23
},
"signature": [
"(state: State | null) => void"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/types.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-public.ISessionStorageStateStorage",
"type": "Interface",
"label": "ISessionStorageStateStorage",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.ISessionStorageStateStorage",
"text": "ISessionStorageStateStorage"
},
" extends ",
"IStateStorage"
],
"description": [
"\n{@link IStateStorage} for storing state in browser {@link Storage}\n{@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md | guide}"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ISessionStorageStateStorage.set",
"type": "Function",
"label": "set",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts",
"lineNumber": 17
},
"signature": [
"<State>(key: string, state: State) => void"
]
},
{
"tags": [],
"id": "def-public.ISessionStorageStateStorage.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts",
"lineNumber": 18
},
"signature": [
"<State = unknown>(key: string) => State | null"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-public.IStateSyncConfig",
"type": "Interface",
"label": "IStateSyncConfig",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStateSyncConfig",
"text": "IStateSyncConfig"
},
"<State, StateStorage>"
],
"description": [
"\nConfig for setting up state syncing with {@link stateSync}"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.IStateSyncConfig.storageKey",
"type": "string",
"label": "storageKey",
"description": [
"\nStorage key to use for syncing,\ne.g. storageKey '_a' should sync state to ?_a query param"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/types.ts",
"lineNumber": 40
}
},
{
"tags": [],
"id": "def-public.IStateSyncConfig.stateContainer",
"type": "Object",
"label": "stateContainer",
"description": [
"\nState container to keep in sync with storage, have to implement {@link INullableBaseStateContainer} interface\nWe encourage to use {@link BaseStateContainer} as a state container,\nbut it is also possible to implement own custom container for advanced use cases"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/types.ts",
"lineNumber": 46
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.INullableBaseStateContainer",
"text": "INullableBaseStateContainer"
},
"<State>"
]
},
{
"tags": [],
"id": "def-public.IStateSyncConfig.stateStorage",
"type": "Uncategorized",
"label": "stateStorage",
"description": [
"\nState storage to use,\nState storage is responsible for serialising / deserialising and persisting / retrieving stored state\n\nThere are common strategies already implemented:\nsee {@link IKbnUrlStateStorage}\nwhich replicate what State (AppState, GlobalState) in legacy world did\n"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/types.ts",
"lineNumber": 56
},
"signature": [
"StateStorage"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/types.ts",
"lineNumber": 32
},
"initialIsOpen": false
},
{
"id": "def-public.IStorage",
"type": "Interface",
"label": "IStorage",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorage",
"text": "IStorage"
},
"<T, S>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IStorage.getItem",
"type": "Function",
"label": "getItem",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 17
},
"signature": [
"(key: string) => T | null"
]
},
{
"tags": [],
"id": "def-public.IStorage.setItem",
"type": "Function",
"label": "setItem",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 18
},
"signature": [
"(key: string, value: T) => S"
]
},
{
"tags": [],
"id": "def-public.IStorage.removeItem",
"type": "Function",
"label": "removeItem",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 19
},
"signature": [
"(key: string) => T | null"
]
},
{
"tags": [],
"id": "def-public.IStorage.clear",
"type": "Function",
"label": "clear",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 20
},
"signature": [
"() => void"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-public.IStorageWrapper",
"type": "Interface",
"label": "IStorageWrapper",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorageWrapper",
"text": "IStorageWrapper"
},
"<T, S>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IStorageWrapper.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 10
},
"signature": [
"(key: string) => T | null"
]
},
{
"tags": [],
"id": "def-public.IStorageWrapper.set",
"type": "Function",
"label": "set",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 11
},
"signature": [
"(key: string, value: T) => S"
]
},
{
"tags": [],
"id": "def-public.IStorageWrapper.remove",
"type": "Function",
"label": "remove",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 12
},
"signature": [
"(key: string) => T | null"
]
},
{
"tags": [],
"id": "def-public.IStorageWrapper.clear",
"type": "Function",
"label": "clear",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 13
},
"signature": [
"() => void"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/storage/types.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-public.ISyncStateRef",
"type": "Interface",
"label": "ISyncStateRef",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.ISyncStateRef",
"text": "ISyncStateRef"
},
"<StateStorage>"
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ISyncStateRef.stop",
"type": "Function",
"label": "stop",
"description": [
"\nstop state syncing"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 34
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.StopSyncStateFnType",
"text": "StopSyncStateFnType"
}
]
},
{
"tags": [],
"id": "def-public.ISyncStateRef.start",
"type": "Function",
"label": "start",
"description": [
"\nstart state syncing"
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 38
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.StartSyncStateFnType",
"text": "StartSyncStateFnType"
}
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 30
},
"initialIsOpen": false
},
{
"id": "def-public.JsonArray",
"type": "Interface",
"label": "JsonArray",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonArray",
"text": "JsonArray"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"[]"
],
"description": [],
"tags": [],
"children": [],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-public.JsonObject",
"type": "Interface",
"label": "JsonObject",
"description": [],
"tags": [],
"children": [
{
"id": "def-public.JsonObject.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 12
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.KibanaServerError",
"type": "Interface",
"label": "KibanaServerError",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KibanaServerError",
"text": "KibanaServerError"
},
"<T>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.KibanaServerError.statusCode",
"type": "number",
"label": "statusCode",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-public.KibanaServerError.message",
"type": "string",
"label": "message",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 11
}
},
{
"tags": [],
"id": "def-public.KibanaServerError.attributes",
"type": "Uncategorized",
"label": "attributes",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 12
},
"signature": [
"T | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-public.ReduxLikeStateContainer",
"type": "Interface",
"label": "ReduxLikeStateContainer",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, PureTransitions, PureSelectors> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<State, PureTransitions, PureSelectors>"
],
"description": [
"\nFully featured state container which matches Redux store interface. Extends {@link StateContainer}.\nAllows to use state container with redux libraries."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ReduxLikeStateContainer.getState",
"type": "Function",
"label": "getState",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 100
},
"signature": [
"() => State"
]
},
{
"tags": [],
"id": "def-public.ReduxLikeStateContainer.reducer",
"type": "Function",
"label": "reducer",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 101
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Reducer",
"text": "Reducer"
},
"<State>"
]
},
{
"tags": [],
"id": "def-public.ReduxLikeStateContainer.replaceReducer",
"type": "Function",
"label": "replaceReducer",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 102
},
"signature": [
"(nextReducer: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Reducer",
"text": "Reducer"
},
"<State>) => void"
]
},
{
"tags": [],
"id": "def-public.ReduxLikeStateContainer.dispatch",
"type": "Function",
"label": "dispatch",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 103
},
"signature": [
"(action: ",
"TransitionDescription",
"<string, any[]>) => void"
]
},
{
"tags": [],
"id": "def-public.ReduxLikeStateContainer.addMiddleware",
"type": "Function",
"label": "addMiddleware",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 104
},
"signature": [
"(middleware: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Middleware",
"text": "Middleware"
},
"<State>) => void"
]
},
{
"tags": [],
"id": "def-public.ReduxLikeStateContainer.subscribe",
"type": "Function",
"label": "subscribe",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 105
},
"signature": [
"(listener: (state: State) => void) => () => void"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 95
},
"initialIsOpen": false
},
{
"id": "def-public.StartServices",
"type": "Interface",
"label": "StartServices",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.StartServices",
"text": "StartServices"
},
"<Plugins, OwnContract, Core>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.StartServices.plugins",
"type": "Uncategorized",
"label": "plugins",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts",
"lineNumber": 12
},
"signature": [
"Plugins"
]
},
{
"tags": [],
"id": "def-public.StartServices.self",
"type": "Uncategorized",
"label": "self",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts",
"lineNumber": 13
},
"signature": [
"OwnContract"
]
},
{
"tags": [],
"id": "def-public.StartServices.core",
"type": "Uncategorized",
"label": "core",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts",
"lineNumber": 14
},
"signature": [
"Core"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.StateContainer",
"type": "Interface",
"label": "StateContainer",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<State, PureTransitions, PureSelectors> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<State>"
],
"description": [
"\nFully featured state container with {@link Selector | Selectors} and {@link Transition | Transitions}. Extends {@link BaseStateContainer}."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.StateContainer.transitions",
"type": "Object",
"label": "transitions",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 86
},
"signature": [
"Readonly<",
"PureTransitionsToTransitions",
"<PureTransitions>>"
]
},
{
"tags": [],
"id": "def-public.StateContainer.selectors",
"type": "Object",
"label": "selectors",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 87
},
"signature": [
"Readonly<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PureSelectorsToSelectors",
"text": "PureSelectorsToSelectors"
},
"<PureSelectors>>"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 81
},
"initialIsOpen": false
},
{
"id": "def-public.UiComponentInstance",
"type": "Interface",
"label": "UiComponentInstance",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponentInstance",
"text": "UiComponentInstance"
},
"<Props>"
],
"description": [
"\nInstance of an UiComponent, corresponds to React virtual DOM node."
],
"tags": [],
"children": [
{
"id": "def-public.UiComponentInstance.render",
"type": "Function",
"label": "render",
"signature": [
"(el: HTMLElement, props: Props) => void"
],
"description": [
"\nCall this method on initial render and on all subsequent updates.\n"
],
"children": [
{
"id": "def-public.UiComponentInstance.render.$1",
"type": "Object",
"label": "el",
"isRequired": true,
"signature": [
"HTMLElement"
],
"description": [
"DOM element."
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 33
}
},
{
"id": "def-public.UiComponentInstance.render.$2",
"type": "Uncategorized",
"label": "props",
"isRequired": true,
"signature": [
"Props"
],
"description": [
"Component props, same as props in React."
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 33
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 33
}
},
{
"id": "def-public.UiComponentInstance.unmount",
"type": "Function",
"label": "unmount",
"signature": [
"(() => void) | undefined"
],
"description": [
"\nUn-mount UI component. Call it to remove view from DOM. Implementers of this\ninterface should clear DOM from this UI component and destroy any internal state."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 39
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 26
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.BaseState",
"type": "Type",
"label": "BaseState",
"tags": [
"public"
],
"description": [
"\nBase {@link StateContainer} state shape"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 17
},
"signature": [
"object"
],
"initialIsOpen": false
},
{
"id": "def-public.Comparator",
"type": "Type",
"label": "Comparator",
"tags": [
"public"
],
"description": [
"\nUsed to compare state, see {@link useContainerSelector}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 177
},
"signature": [
"(previous: Result, current: Result) => boolean"
],
"initialIsOpen": false
},
{
"id": "def-public.Connect",
"type": "Type",
"label": "Connect",
"tags": [
"public"
],
"description": [
"\nSimilar to `connect` from react-redux,\nallows to map state from state container to component's props."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 191
},
"signature": [
"(mapStateToProp: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MapStateToProps",
"text": "MapStateToProps"
},
"<State, Pick<Props, StatePropKeys>>) => (component: React.ComponentType<Props>) => React.FC<Pick<Props, Exclude<keyof Props, StatePropKeys>>>"
],
"initialIsOpen": false
},
{
"id": "def-public.Dispatch",
"type": "Type",
"label": "Dispatch",
"tags": [
"public"
],
"description": [
"\nRedux like dispatch"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 112
},
"signature": [
"(action: T) => void"
],
"initialIsOpen": false
},
{
"id": "def-public.EnsurePureSelector",
"type": "Type",
"label": "EnsurePureSelector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 159
},
"signature": [
"(state: any) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Selector",
"text": "Selector"
},
"<any, any>"
],
"initialIsOpen": false
},
{
"id": "def-public.EnsurePureTransition",
"type": "Type",
"label": "EnsurePureTransition",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 39
},
"signature": [
"(state: any) => ",
"Transition",
"<any, any>"
],
"initialIsOpen": false
},
{
"id": "def-public.Get",
"type": "Type",
"label": "Get",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 9
},
"signature": [
"() => T"
],
"initialIsOpen": false
},
{
"id": "def-public.JsonValue",
"type": "Type",
"label": "JsonValue",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 9
},
"signature": [
"null | string | number | false | true | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
},
" | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonArray",
"text": "JsonArray"
}
],
"initialIsOpen": false
},
{
"id": "def-public.MapStateToProps",
"type": "Type",
"label": "MapStateToProps",
"tags": [
"public"
],
"description": [
"\nState container state to component props mapper.\nSee {@link Connect}"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 183
},
"signature": [
"(state: State) => StateProps"
],
"initialIsOpen": false
},
{
"id": "def-public.Middleware",
"type": "Type",
"label": "Middleware",
"tags": [
"public"
],
"description": [
"\nRedux like Middleware"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 117
},
"signature": [
"(store: Pick<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, any, {}>, \"getState\" | \"dispatch\">) => (next: (action: ",
"TransitionDescription",
"<string, any[]>) => any) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Dispatch",
"text": "Dispatch"
},
"<",
"TransitionDescription",
"<string, any[]>>"
],
"initialIsOpen": false
},
{
"id": "def-public.PureSelector",
"type": "Type",
"label": "PureSelector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 153
},
"signature": [
"(state: State) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Selector",
"text": "Selector"
},
"<Result, Args>"
],
"initialIsOpen": false
},
{
"id": "def-public.PureSelectorsToSelectors",
"type": "Type",
"label": "PureSelectorsToSelectors",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 169
},
"signature": [
"{ [K in keyof T]: ReturnType<Ensure<Ensure<T[K], PureSelector<any, any, any>>, PureSelector<any, any, any>>>; }"
],
"initialIsOpen": false
},
{
"id": "def-public.PureSelectorToSelector",
"type": "Type",
"label": "PureSelectorToSelector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 163
},
"signature": [
"(args: any) => any"
],
"initialIsOpen": false
},
{
"id": "def-public.Reducer",
"type": "Type",
"label": "Reducer",
"tags": [
"public"
],
"description": [
"\nRedux like Reducer"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 126
},
"signature": [
"(state: State, action: ",
"TransitionDescription",
"<string, any[]>) => State"
],
"initialIsOpen": false
},
{
"id": "def-public.Selector",
"type": "Type",
"label": "Selector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 149
},
"signature": [
"(args: Args) => Result"
],
"initialIsOpen": false
},
{
"id": "def-public.Set",
"type": "Type",
"label": "Set",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 10
},
"signature": [
"(value: T) => void"
],
"initialIsOpen": false
},
{
"id": "def-public.StartServicesGetter",
"type": "Type",
"label": "StartServicesGetter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts",
"lineNumber": 17
},
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.StartServices",
"text": "StartServices"
},
"<Plugins, OwnContract, ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
">"
],
"initialIsOpen": false
},
{
"id": "def-public.StartSyncStateFnType",
"type": "Type",
"label": "StartSyncStateFnType",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 25
},
"signature": [
"() => void"
],
"initialIsOpen": false
},
{
"id": "def-public.StopSyncStateFnType",
"type": "Type",
"label": "StopSyncStateFnType",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts",
"lineNumber": 21
},
"signature": [
"() => void"
],
"initialIsOpen": false
},
{
"id": "def-public.UiComponent",
"type": "Type",
"label": "UiComponent",
"tags": [],
"description": [
"\nIn many places in Kibana we want to be agnostic to frontend view library,\ni.e. instead of exposing React-specific APIs we want to expose APIs that\nare orthogonal to any rendering library. This interface represents such UI\ncomponents. UI component receives a DOM element and `props` through `render()`\nmethod, the `render()` method can be called many times.\n\nAlthough Kibana aims to be library agnostic, Kibana itself is written in React,\nthus here we define `UiComponent` which is an abstract unit of UI that can be\nimplemented in any framework, but it maps easily to React components, i.e.\n`UiComponent<Props>` is like `React.ComponentType<Props>`."
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 21
},
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponentInstance",
"text": "UiComponentInstance"
},
"<Props>"
],
"initialIsOpen": false
},
{
"id": "def-public.UnboxState",
"type": "Type",
"label": "UnboxState",
"tags": [
"public"
],
"description": [
"\nUtility type for inferring state shape from {@link StateContainer}"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 135
},
"signature": [
"Container extends StateContainer<infer T, any, {}> ? T : never"
],
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"id": "def-public.hashedItemStore",
"type": "Object",
"label": "hashedItemStore",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/public/storage/hashed_item_store/index.ts",
"lineNumber": 11
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.HashedItemStore",
"text": "HashedItemStore"
}
],
"initialIsOpen": false
},
{
"id": "def-public.url",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.url.encodeQuery",
"type": "Function",
"label": "encodeQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 12
},
"signature": [
"(query: ",
"ParsedQuery",
"<string>, encodeFunction?: (val: string, pctEncodeSpaces?: boolean | undefined) => string, pctEncodeSpaces?: boolean) => ",
"ParsedQuery",
"<string>"
]
},
{
"tags": [],
"id": "def-public.url.encodeUriQuery",
"type": "Function",
"label": "encodeUriQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 13
},
"signature": [
"typeof ",
"encodeUriQuery"
]
},
{
"tags": [],
"id": "def-public.url.addQueryParam",
"type": "Function",
"label": "addQueryParam",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 14
},
"signature": [
"(params: string, key: string, value?: string | undefined) => string"
]
}
],
"description": [],
"label": "url",
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 11
},
"initialIsOpen": false
}
]
},
"server": {
"classes": [
{
"id": "def-server.AbortError",
"type": "Class",
"tags": [],
"label": "AbortError",
"description": [
"\nClass used to signify that something was aborted. Useful for applications to conditionally handle\nthis type of error differently than other errors."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.AbortError",
"text": "AbortError"
},
" extends Error"
],
"children": [
{
"id": "def-server.AbortError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.AbortError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 14
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-server.KbnServerError",
"type": "Class",
"tags": [],
"label": "KbnServerError",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "server",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-server.KbnServerError",
"text": "KbnServerError"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"tags": [],
"id": "def-server.KbnServerError.errBody",
"type": "Object",
"label": "errBody",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 14
},
"signature": [
"Record<string, any> | undefined"
]
},
{
"id": "def-server.KbnServerError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.KbnServerError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 15
}
},
{
"id": "def-server.KbnServerError.Unnamed.$2",
"type": "number",
"label": "statusCode",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 15
}
},
{
"id": "def-server.KbnServerError.Unnamed.$3",
"type": "Object",
"label": "errBody",
"isRequired": false,
"signature": [
"Record<string, any> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 15
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 15
}
}
],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 13
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-server.abortSignalToPromise",
"type": "Function",
"label": "abortSignalToPromise",
"signature": [
"(signal: AbortSignal) => { promise: Promise<never>; cleanup: () => void; }"
],
"description": [
"\nReturns a `Promise` corresponding with when the given `AbortSignal` is aborted. Useful for\nsituations when you might need to `Promise.race` multiple `AbortSignal`s, or an `AbortSignal`\nwith any other expected errors (or completions).\n"
],
"children": [
{
"id": "def-server.abortSignalToPromise.$1",
"type": "Object",
"label": "signal",
"isRequired": true,
"signature": [
"AbortSignal"
],
"description": [
"The `AbortSignal` to generate the `Promise` from"
],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 28
},
"initialIsOpen": false
},
{
"id": "def-server.createGetterSetter",
"type": "Function",
"children": [
{
"id": "def-server.createGetterSetter.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 12
}
}
],
"signature": [
"<T extends object>(name: string) => [",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Get",
"text": "Get"
},
"<T>, ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Set",
"text": "Set"
},
"<T>]"
],
"description": [],
"label": "createGetterSetter",
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.fieldWildcardFilter",
"type": "Function",
"label": "fieldWildcardFilter",
"signature": [
"(globs: string[], metaFields: string[]) => (val: unknown) => boolean"
],
"description": [],
"children": [
{
"id": "def-server.fieldWildcardFilter.$1",
"type": "Array",
"label": "globs",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
}
},
{
"id": "def-server.fieldWildcardFilter.$2",
"type": "Array",
"label": "metaFields",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
},
"initialIsOpen": false
},
{
"id": "def-server.fieldWildcardMatcher",
"type": "Function",
"label": "fieldWildcardMatcher",
"signature": [
"(globs: string[], metaFields: unknown[]) => (val: unknown) => boolean"
],
"description": [],
"children": [
{
"id": "def-server.fieldWildcardMatcher.$1",
"type": "Array",
"label": "globs",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
}
},
{
"id": "def-server.fieldWildcardMatcher.$2",
"type": "Array",
"label": "metaFields",
"isRequired": true,
"signature": [
"unknown[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-server.getKbnServerError",
"type": "Function",
"label": "getKbnServerError",
"signature": [
"(e: Error) => ",
{
"pluginId": "kibanaUtils",
"scope": "server",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-server.KbnServerError",
"text": "KbnServerError"
}
],
"description": [
"\nFormats any error thrown into a standardized `KbnServerError`."
],
"children": [
{
"id": "def-server.getKbnServerError.$1",
"type": "Object",
"label": "e",
"isRequired": true,
"signature": [
"Error"
],
"description": [
"`Error` or `ElasticsearchClientError`"
],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 26
}
}
],
"tags": [],
"returnComment": [
"`KbnServerError`"
],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-server.reportServerError",
"type": "Function",
"label": "reportServerError",
"signature": [
"(res: { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
"Stream",
" | undefined>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.CustomHttpResponseOptions",
"text": "CustomHttpResponseOptions"
},
"<T>) => ",
"KibanaResponse",
"<T>; badRequest: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse"
],
"description": [
"\n"
],
"children": [
{
"id": "def-server.reportServerError.$1",
"type": "Object",
"label": "res",
"isRequired": true,
"signature": [
"{ custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
"Stream",
" | undefined>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.CustomHttpResponseOptions",
"text": "CustomHttpResponseOptions"
},
"<T>) => ",
"KibanaResponse",
"<T>; badRequest: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse"
],
"description": [
"Formats a `KbnServerError` into a server error response"
],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 39
}
},
{
"id": "def-server.reportServerError.$2",
"type": "Object",
"label": "err",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "server",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-server.KbnServerError",
"text": "KbnServerError"
}
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 39
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/server/report_server_error.ts",
"lineNumber": 39
},
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"id": "def-server.Get",
"type": "Type",
"label": "Get",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 9
},
"signature": [
"() => T"
],
"initialIsOpen": false
},
{
"id": "def-server.Set",
"type": "Type",
"label": "Set",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 10
},
"signature": [
"(value: T) => void"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-server.url",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.url.encodeQuery",
"type": "Function",
"label": "encodeQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 12
},
"signature": [
"(query: ",
"ParsedQuery",
"<string>, encodeFunction?: (val: string, pctEncodeSpaces?: boolean | undefined) => string, pctEncodeSpaces?: boolean) => ",
"ParsedQuery",
"<string>"
]
},
{
"tags": [],
"id": "def-server.url.encodeUriQuery",
"type": "Function",
"label": "encodeUriQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 13
},
"signature": [
"typeof ",
"encodeUriQuery"
]
},
{
"tags": [],
"id": "def-server.url.addQueryParam",
"type": "Function",
"label": "addQueryParam",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 14
},
"signature": [
"(params: string, key: string, value?: string | undefined) => string"
]
}
],
"description": [],
"label": "url",
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 11
},
"initialIsOpen": false
}
]
},
"common": {
"classes": [
{
"id": "def-common.AbortError",
"type": "Class",
"tags": [],
"label": "AbortError",
"description": [
"\nClass used to signify that something was aborted. Useful for applications to conditionally handle\nthis type of error differently than other errors."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.AbortError",
"text": "AbortError"
},
" extends Error"
],
"children": [
{
"id": "def-common.AbortError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.AbortError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 14
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.Defer",
"type": "Class",
"tags": [],
"label": "Defer",
"description": [
"\nAn externally resolvable/rejectable \"promise\". Use it to resolve/reject\npromise at any time.\n\n```ts\nconst future = new Defer();\n\nfuture.promise.then(value => console.log(value));\n\nfuture.resolve(123);\n```"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Defer",
"text": "Defer"
},
"<T>"
],
"children": [
{
"tags": [],
"id": "def-common.Defer.resolve",
"type": "Function",
"label": "resolve",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 22
},
"signature": [
"(data: T) => void"
]
},
{
"tags": [],
"id": "def-common.Defer.reject",
"type": "Function",
"label": "reject",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 23
},
"signature": [
"(error: any) => void"
]
},
{
"tags": [],
"id": "def-common.Defer.promise",
"type": "Object",
"label": "promise",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 24
},
"signature": [
"Promise<T>"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-common.DuplicateField",
"type": "Class",
"tags": [],
"label": "DuplicateField",
"description": [
"\nwhen a mapping already exists for a field the user is attempting to add"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.DuplicateField",
"text": "DuplicateField"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-common.DuplicateField.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.DuplicateField.Unnamed.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 24
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 24
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 23
},
"initialIsOpen": false
},
{
"id": "def-common.InvalidJSONProperty",
"type": "Class",
"tags": [],
"label": "InvalidJSONProperty",
"description": [
"\nThis error is for scenarios where a saved object is detected that has invalid JSON properties.\nThere was a scenario where we were importing objects with double-encoded JSON, and the system\nwas silently failing. This error is now thrown in those scenarios."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.InvalidJSONProperty",
"text": "InvalidJSONProperty"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-common.InvalidJSONProperty.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.InvalidJSONProperty.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 74
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 74
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 73
},
"initialIsOpen": false
},
{
"id": "def-common.KbnError",
"type": "Class",
"tags": [],
"label": "KbnError",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
},
" extends Error"
],
"children": [
{
"id": "def-common.KbnError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.KbnError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 13
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 13
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-common.SavedFieldNotFound",
"type": "Class",
"tags": [],
"label": "SavedFieldNotFound",
"description": [
"\nA saved field doesn't exist anymore"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedFieldNotFound",
"text": "SavedFieldNotFound"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-common.SavedFieldNotFound.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.SavedFieldNotFound.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 54
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 54
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 53
},
"initialIsOpen": false
},
{
"id": "def-common.SavedFieldTypeInvalidForAgg",
"type": "Class",
"tags": [],
"label": "SavedFieldTypeInvalidForAgg",
"description": [
"\nA saved field type isn't compatible with aggregation"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedFieldTypeInvalidForAgg",
"text": "SavedFieldTypeInvalidForAgg"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"id": "def-common.SavedFieldTypeInvalidForAgg.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.SavedFieldTypeInvalidForAgg.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 63
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 63
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 62
},
"initialIsOpen": false
},
{
"id": "def-common.SavedObjectNotFound",
"type": "Class",
"tags": [],
"label": "SavedObjectNotFound",
"description": [
"\nA saved object was not found"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SavedObjectNotFound",
"text": "SavedObjectNotFound"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"children": [
{
"tags": [],
"id": "def-common.SavedObjectNotFound.savedObjectType",
"type": "string",
"label": "savedObjectType",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-common.SavedObjectNotFound.savedObjectId",
"type": "string",
"label": "savedObjectId",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 34
},
"signature": [
"string | undefined"
]
},
{
"id": "def-common.SavedObjectNotFound.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.SavedObjectNotFound.Unnamed.$1",
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
},
{
"id": "def-common.SavedObjectNotFound.Unnamed.$2",
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
},
{
"id": "def-common.SavedObjectNotFound.Unnamed.$3",
"type": "string",
"label": "link",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
},
{
"id": "def-common.SavedObjectNotFound.Unnamed.$4",
"type": "string",
"label": "customMessage",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 35
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"lineNumber": 32
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-common.abortSignalToPromise",
"type": "Function",
"label": "abortSignalToPromise",
"signature": [
"(signal: AbortSignal) => { promise: Promise<never>; cleanup: () => void; }"
],
"description": [
"\nReturns a `Promise` corresponding with when the given `AbortSignal` is aborted. Useful for\nsituations when you might need to `Promise.race` multiple `AbortSignal`s, or an `AbortSignal`\nwith any other expected errors (or completions).\n"
],
"children": [
{
"id": "def-common.abortSignalToPromise.$1",
"type": "Object",
"label": "signal",
"isRequired": true,
"signature": [
"AbortSignal"
],
"description": [
"The `AbortSignal` to generate the `Promise` from"
],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/abort_utils.ts",
"lineNumber": 28
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.calculateObjectHash",
"type": "Function",
"label": "calculateObjectHash",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/calculate_object_hash.ts",
"lineNumber": 73
},
"signature": [
"typeof sum"
],
"initialIsOpen": false
},
{
"id": "def-common.createGetterSetter",
"type": "Function",
"children": [
{
"id": "def-common.createGetterSetter.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 12
}
}
],
"signature": [
"<T extends object>(name: string) => [",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Get",
"text": "Get"
},
"<T>, ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Set",
"text": "Set"
},
"<T>]"
],
"description": [],
"label": "createGetterSetter",
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.createStateContainer",
"type": "Function",
"label": "createStateContainer",
"signature": [
"(defaultState: State) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, {}, {}>"
],
"description": [
"\nCreates a state container without transitions and without selectors."
],
"children": [
{
"id": "def-common.createStateContainer.$1",
"type": "Uncategorized",
"label": "defaultState",
"isRequired": true,
"signature": [
"State"
],
"description": [
"- initial state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 64
}
}
],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 63
},
"initialIsOpen": false
},
{
"id": "def-common.createStateContainer",
"type": "Function",
"label": "createStateContainer",
"signature": [
"(defaultState: State, pureTransitions: PureTransitions) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, PureTransitions, {}>"
],
"description": [
"\nCreates a state container with transitions, but without selectors."
],
"children": [
{
"id": "def-common.createStateContainer.$1",
"type": "Uncategorized",
"label": "defaultState",
"isRequired": true,
"signature": [
"State"
],
"description": [
"- initial state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 74
}
},
{
"id": "def-common.createStateContainer.$2",
"type": "Uncategorized",
"label": "pureTransitions",
"isRequired": true,
"signature": [
"PureTransitions"
],
"description": [
"- state transitions configuration object. Map of {@link PureTransition}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 75
}
}
],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 73
},
"initialIsOpen": false
},
{
"id": "def-common.createStateContainer",
"type": "Function",
"label": "createStateContainer",
"signature": [
"(defaultState: State, pureTransitions: PureTransitions, pureSelectors: PureSelectors, options: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.CreateStateContainerOptions",
"text": "CreateStateContainerOptions"
},
" | undefined) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, PureTransitions, PureSelectors>"
],
"description": [
"\nCreates a state container with transitions and selectors."
],
"children": [
{
"id": "def-common.createStateContainer.$1",
"type": "Uncategorized",
"label": "defaultState",
"isRequired": true,
"signature": [
"State"
],
"description": [
"- initial state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 92
}
},
{
"id": "def-common.createStateContainer.$2",
"type": "Uncategorized",
"label": "pureTransitions",
"isRequired": true,
"signature": [
"PureTransitions"
],
"description": [
"- state transitions configuration object. Map of {@link PureTransition}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 93
}
},
{
"id": "def-common.createStateContainer.$3",
"type": "Uncategorized",
"label": "pureSelectors",
"isRequired": true,
"signature": [
"PureSelectors"
],
"description": [
"- state selectors configuration object. Map of {@link PureSelectors}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 94
}
},
{
"id": "def-common.createStateContainer.$4",
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.CreateStateContainerOptions",
"text": "CreateStateContainerOptions"
},
" | undefined"
],
"description": [
"- state container options {@link CreateStateContainerOptions}"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 95
}
}
],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 87
},
"initialIsOpen": false
},
{
"id": "def-common.createStateContainerReactHelpers",
"type": "Function",
"children": [],
"signature": [
"<Container extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<any, any, {}>>() => { Provider: React.Provider<Container>; Consumer: React.Consumer<Container>; context: React.Context<Container>; useContainer: () => Container; useState: () => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>; useTransitions: () => Container[\"transitions\"]; useSelector: <Result>(selector: (state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>) => Result, comparator?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Comparator",
"text": "Comparator"
},
"<Result>) => Result; connect: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Connect",
"text": "Connect"
}
],
"description": [
"\nCreates helpers for using {@link StateContainer | State Containers} with react\nRefer to {@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_containers/react.md | guide} for details"
],
"label": "createStateContainerReactHelpers",
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 69
},
"tags": [
"public"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.defer",
"type": "Function",
"children": [],
"signature": [
"<T>() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Defer",
"text": "Defer"
},
"<T>"
],
"description": [],
"label": "defer",
"source": {
"path": "src/plugins/kibana_utils/common/defer.ts",
"lineNumber": 30
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.distinctUntilChangedWithInitialValue",
"type": "Function",
"label": "distinctUntilChangedWithInitialValue",
"signature": [
"(initialValue: T | Promise<T>, compare: ((x: T, y: T) => boolean) | undefined) => ",
"MonoTypeOperatorFunction",
"<T>"
],
"description": [],
"children": [
{
"id": "def-common.distinctUntilChangedWithInitialValue.$1",
"type": "CompoundType",
"label": "initialValue",
"isRequired": true,
"signature": [
"T | Promise<T>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/distinct_until_changed_with_initial_value.ts",
"lineNumber": 13
}
},
{
"id": "def-common.distinctUntilChangedWithInitialValue.$2",
"type": "Function",
"label": "compare",
"isRequired": false,
"signature": [
"((x: T, y: T) => boolean) | undefined"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/distinct_until_changed_with_initial_value.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/distinct_until_changed_with_initial_value.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-common.fieldWildcardFilter",
"type": "Function",
"label": "fieldWildcardFilter",
"signature": [
"(globs: string[], metaFields: string[]) => (val: unknown) => boolean"
],
"description": [],
"children": [
{
"id": "def-common.fieldWildcardFilter.$1",
"type": "Array",
"label": "globs",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
}
},
{
"id": "def-common.fieldWildcardFilter.$2",
"type": "Array",
"label": "metaFields",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 29
},
"initialIsOpen": false
},
{
"id": "def-common.fieldWildcardMatcher",
"type": "Function",
"label": "fieldWildcardMatcher",
"signature": [
"(globs: string[], metaFields: unknown[]) => (val: unknown) => boolean"
],
"description": [],
"children": [
{
"id": "def-common.fieldWildcardMatcher.$1",
"type": "Array",
"label": "globs",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
}
},
{
"id": "def-common.fieldWildcardMatcher.$2",
"type": "Array",
"label": "metaFields",
"isRequired": true,
"signature": [
"unknown[]"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.makeRegEx",
"type": "Function",
"label": "makeRegEx",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/field_wildcard.ts",
"lineNumber": 12
},
"signature": [
"((glob: string) => RegExp) & _.MemoizedFunction"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.now",
"type": "Function",
"label": "now",
"description": [
"\nFunction that returns number in milliseconds since some undefined point in\ntime. Use this function for performance measurements."
],
"source": {
"path": "src/plugins/kibana_utils/common/now.ts",
"lineNumber": 13
},
"signature": [
"() => number"
],
"initialIsOpen": false
},
{
"id": "def-common.of",
"type": "Function",
"children": [
{
"id": "def-common.of.$1",
"type": "Object",
"label": "promise",
"isRequired": true,
"signature": [
"Promise<T>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/of.ts",
"lineNumber": 19
}
}
],
"signature": [
"<T, E = any>(promise: Promise<T>) => Promise<[T | undefined, E | undefined, boolean]>"
],
"description": [
"\nGiven a promise awaits it and returns a 3-tuple, with the following members:\n\n- First entry is either the resolved value of the promise or `undefined`.\n- Second entry is either the error thrown by promise or `undefined`.\n- Third entry is a boolean, truthy if promise was resolved and falsy if rejected.\n"
],
"label": "of",
"source": {
"path": "src/plugins/kibana_utils/common/of.ts",
"lineNumber": 18
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.useContainerSelector",
"type": "Function",
"children": [
{
"id": "def-common.useContainerSelector.$1",
"type": "Uncategorized",
"label": "container",
"isRequired": true,
"signature": [
"Container"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 40
}
},
{
"id": "def-common.useContainerSelector.$2",
"type": "Function",
"label": "selector",
"isRequired": true,
"signature": [
"(state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>) => Result"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 41
}
},
{
"id": "def-common.useContainerSelector.$3",
"type": "Function",
"label": "comparator",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Comparator",
"text": "Comparator"
},
"<Result>"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 42
}
}
],
"signature": [
"<Container extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<any, any, {}>, Result>(container: Container, selector: (state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>) => Result, comparator?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Comparator",
"text": "Comparator"
},
"<Result>) => Result"
],
"description": [
"\nReact hook to apply selector to state container to extract only needed information. Will\nre-render your component only when the section changes.\n"
],
"label": "useContainerSelector",
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 39
},
"tags": [
"public"
],
"returnComment": [
"- result of a selector(state)"
],
"initialIsOpen": false
},
{
"id": "def-common.useContainerState",
"type": "Function",
"children": [
{
"id": "def-common.useContainerState.$1",
"type": "Uncategorized",
"label": "container",
"isRequired": true,
"signature": [
"Container"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 24
}
}
],
"signature": [
"<Container extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<any, any, {}>>(container: Container) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UnboxState",
"text": "UnboxState"
},
"<Container>"
],
"description": [
"\nReact hooks that returns the latest state of a {@link StateContainer}.\n"
],
"label": "useContainerState",
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container_react_helpers.ts",
"lineNumber": 23
},
"tags": [
"public"
],
"returnComment": [
"- latest {@link StateContainer} state"
],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.BaseStateContainer",
"type": "Interface",
"label": "BaseStateContainer",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<State>"
],
"description": [
"\nBase state container shape without transitions or selectors"
],
"tags": [
"public"
],
"children": [
{
"tags": [
"public"
],
"id": "def-common.BaseStateContainer.get",
"type": "Function",
"label": "get",
"description": [
"\nRetrieves current state from the container"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 62
},
"signature": [
"() => State"
]
},
{
"tags": [],
"id": "def-common.BaseStateContainer.set",
"type": "Function",
"label": "set",
"description": [
"\nSets state into container"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 67
},
"signature": [
"(state: State) => void"
]
},
{
"tags": [],
"id": "def-common.BaseStateContainer.state$",
"type": "Object",
"label": "state$",
"description": [
"\n{@link Observable} of state"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 71
},
"signature": [
"Observable",
"<State>"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 56
},
"initialIsOpen": false
},
{
"id": "def-common.CreateStateContainerOptions",
"type": "Interface",
"label": "CreateStateContainerOptions",
"description": [
"\nState container options"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-common.CreateStateContainerOptions.freeze",
"type": "Function",
"label": "freeze",
"description": [
"\nFunction to use when freezing state. Supply identity function.\nIf not provided, default `deepFreeze` is used.\n"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 54
},
"signature": [
"(<T>(state: T) => T) | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts",
"lineNumber": 40
},
"initialIsOpen": false
},
{
"id": "def-common.JsonArray",
"type": "Interface",
"label": "JsonArray",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonArray",
"text": "JsonArray"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"[]"
],
"description": [],
"tags": [],
"children": [],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-common.JsonObject",
"type": "Interface",
"label": "JsonObject",
"description": [],
"tags": [],
"children": [
{
"id": "def-common.JsonObject.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 12
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.KibanaServerError",
"type": "Interface",
"label": "KibanaServerError",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KibanaServerError",
"text": "KibanaServerError"
},
"<T>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.KibanaServerError.statusCode",
"type": "number",
"label": "statusCode",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-common.KibanaServerError.message",
"type": "string",
"label": "message",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 11
}
},
{
"tags": [],
"id": "def-common.KibanaServerError.attributes",
"type": "Uncategorized",
"label": "attributes",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 12
},
"signature": [
"T | undefined"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/errors/types.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-common.PersistableState",
"type": "Interface",
"label": "PersistableState",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<P>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PersistableState.telemetry",
"type": "Function",
"label": "telemetry",
"description": [
"\n function to extract telemetry information"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 69
},
"signature": [
"(state: P, collector: Record<string, any>) => Record<string, any>"
]
},
{
"tags": [],
"id": "def-common.PersistableState.inject",
"type": "Function",
"label": "inject",
"description": [
"\ninject function receives state and a list of references and should return state with references injected\ndefault is identity function"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 76
},
"signature": [
"(state: P, references: ",
"SavedObjectReference",
"[]) => P"
]
},
{
"tags": [],
"id": "def-common.PersistableState.extract",
"type": "Function",
"label": "extract",
"description": [
"\nextract function receives state and should return state with references extracted and array of references\ndefault returns same state with empty reference array"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 82
},
"signature": [
"(state: P) => { state: P; references: ",
"SavedObjectReference",
"[]; }"
]
},
{
"tags": [],
"id": "def-common.PersistableState.migrations",
"type": "Object",
"label": "migrations",
"description": [
"\nlist of all migrations per semver"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 87
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MigrateFunctionsObject",
"text": "MigrateFunctionsObject"
}
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 63
},
"initialIsOpen": false
},
{
"id": "def-common.PersistableStateService",
"type": "Interface",
"label": "PersistableStateService",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableStateService",
"text": "PersistableStateService"
},
"<P>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PersistableStateService.telemetry",
"type": "Function",
"label": "telemetry",
"description": [
"\n function to extract telemetry information"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 33
},
"signature": [
"(state: P, collector: Record<string, any>) => Record<string, any>"
]
},
{
"tags": [],
"id": "def-common.PersistableStateService.inject",
"type": "Function",
"label": "inject",
"description": [
"\ninject function receives state and a list of references and should return state with references injected\ndefault is identity function"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 40
},
"signature": [
"(state: P, references: ",
"SavedObjectReference",
"[]) => P"
]
},
{
"tags": [],
"id": "def-common.PersistableStateService.extract",
"type": "Function",
"label": "extract",
"description": [
"\nextract function receives state and should return state with references extracted and array of references\ndefault returns same state with empty reference array"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 46
},
"signature": [
"(state: P) => { state: P; references: ",
"SavedObjectReference",
"[]; }"
]
},
{
"tags": [],
"id": "def-common.PersistableStateService.migrateToLatest",
"type": "Function",
"label": "migrateToLatest",
"description": [
"\nmigrateToLatest function receives state of older version and should migrate to the latest version"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 53
},
"signature": [
"((state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SerializableState",
"text": "SerializableState"
},
", version: string) => P) | undefined"
]
},
{
"tags": [],
"id": "def-common.PersistableStateService.migrate",
"type": "Function",
"label": "migrate",
"description": [
"\nmigrate function runs the specified migration"
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 60
},
"signature": [
"(state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SerializableState",
"text": "SerializableState"
},
", version: string) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SerializableState",
"text": "SerializableState"
}
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 27
},
"initialIsOpen": false
},
{
"id": "def-common.ReduxLikeStateContainer",
"type": "Interface",
"label": "ReduxLikeStateContainer",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, PureTransitions, PureSelectors> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<State, PureTransitions, PureSelectors>"
],
"description": [
"\nFully featured state container which matches Redux store interface. Extends {@link StateContainer}.\nAllows to use state container with redux libraries."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-common.ReduxLikeStateContainer.getState",
"type": "Function",
"label": "getState",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 100
},
"signature": [
"() => State"
]
},
{
"tags": [],
"id": "def-common.ReduxLikeStateContainer.reducer",
"type": "Function",
"label": "reducer",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 101
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Reducer",
"text": "Reducer"
},
"<State>"
]
},
{
"tags": [],
"id": "def-common.ReduxLikeStateContainer.replaceReducer",
"type": "Function",
"label": "replaceReducer",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 102
},
"signature": [
"(nextReducer: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Reducer",
"text": "Reducer"
},
"<State>) => void"
]
},
{
"tags": [],
"id": "def-common.ReduxLikeStateContainer.dispatch",
"type": "Function",
"label": "dispatch",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 103
},
"signature": [
"(action: ",
"TransitionDescription",
"<string, any[]>) => void"
]
},
{
"tags": [],
"id": "def-common.ReduxLikeStateContainer.addMiddleware",
"type": "Function",
"label": "addMiddleware",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 104
},
"signature": [
"(middleware: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Middleware",
"text": "Middleware"
},
"<State>) => void"
]
},
{
"tags": [],
"id": "def-common.ReduxLikeStateContainer.subscribe",
"type": "Function",
"label": "subscribe",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 105
},
"signature": [
"(listener: (state: State) => void) => () => void"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 95
},
"initialIsOpen": false
},
{
"id": "def-common.StateContainer",
"type": "Interface",
"label": "StateContainer",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<State, PureTransitions, PureSelectors> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<State>"
],
"description": [
"\nFully featured state container with {@link Selector | Selectors} and {@link Transition | Transitions}. Extends {@link BaseStateContainer}."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-common.StateContainer.transitions",
"type": "Object",
"label": "transitions",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 86
},
"signature": [
"Readonly<",
"PureTransitionsToTransitions",
"<PureTransitions>>"
]
},
{
"tags": [],
"id": "def-common.StateContainer.selectors",
"type": "Object",
"label": "selectors",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 87
},
"signature": [
"Readonly<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PureSelectorsToSelectors",
"text": "PureSelectorsToSelectors"
},
"<PureSelectors>>"
]
}
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 81
},
"initialIsOpen": false
},
{
"id": "def-common.UiComponentInstance",
"type": "Interface",
"label": "UiComponentInstance",
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponentInstance",
"text": "UiComponentInstance"
},
"<Props>"
],
"description": [
"\nInstance of an UiComponent, corresponds to React virtual DOM node."
],
"tags": [],
"children": [
{
"id": "def-common.UiComponentInstance.render",
"type": "Function",
"label": "render",
"signature": [
"(el: HTMLElement, props: Props) => void"
],
"description": [
"\nCall this method on initial render and on all subsequent updates.\n"
],
"children": [
{
"id": "def-common.UiComponentInstance.render.$1",
"type": "Object",
"label": "el",
"isRequired": true,
"signature": [
"HTMLElement"
],
"description": [
"DOM element."
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 33
}
},
{
"id": "def-common.UiComponentInstance.render.$2",
"type": "Uncategorized",
"label": "props",
"isRequired": true,
"signature": [
"Props"
],
"description": [
"Component props, same as props in React."
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 33
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 33
}
},
{
"id": "def-common.UiComponentInstance.unmount",
"type": "Function",
"label": "unmount",
"signature": [
"(() => void) | undefined"
],
"description": [
"\nUn-mount UI component. Call it to remove view from DOM. Implementers of this\ninterface should clear DOM from this UI component and destroy any internal state."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 39
}
}
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 26
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-common.BaseState",
"type": "Type",
"label": "BaseState",
"tags": [
"public"
],
"description": [
"\nBase {@link StateContainer} state shape"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 17
},
"signature": [
"object"
],
"initialIsOpen": false
},
{
"id": "def-common.Comparator",
"type": "Type",
"label": "Comparator",
"tags": [
"public"
],
"description": [
"\nUsed to compare state, see {@link useContainerSelector}."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 177
},
"signature": [
"(previous: Result, current: Result) => boolean"
],
"initialIsOpen": false
},
{
"id": "def-common.Connect",
"type": "Type",
"label": "Connect",
"tags": [
"public"
],
"description": [
"\nSimilar to `connect` from react-redux,\nallows to map state from state container to component's props."
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 191
},
"signature": [
"(mapStateToProp: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MapStateToProps",
"text": "MapStateToProps"
},
"<State, Pick<Props, StatePropKeys>>) => (component: React.ComponentType<Props>) => React.FC<Pick<Props, Exclude<keyof Props, StatePropKeys>>>"
],
"initialIsOpen": false
},
{
"id": "def-common.Dispatch",
"type": "Type",
"label": "Dispatch",
"tags": [
"public"
],
"description": [
"\nRedux like dispatch"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 112
},
"signature": [
"(action: T) => void"
],
"initialIsOpen": false
},
{
"id": "def-common.EnsurePureSelector",
"type": "Type",
"label": "EnsurePureSelector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 159
},
"signature": [
"(state: any) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Selector",
"text": "Selector"
},
"<any, any>"
],
"initialIsOpen": false
},
{
"id": "def-common.EnsurePureTransition",
"type": "Type",
"label": "EnsurePureTransition",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 39
},
"signature": [
"(state: any) => ",
"Transition",
"<any, any>"
],
"initialIsOpen": false
},
{
"id": "def-common.Get",
"type": "Type",
"label": "Get",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 9
},
"signature": [
"() => T"
],
"initialIsOpen": false
},
{
"id": "def-common.JsonValue",
"type": "Type",
"label": "JsonValue",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/typed_json.ts",
"lineNumber": 9
},
"signature": [
"null | string | number | false | true | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
},
" | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonArray",
"text": "JsonArray"
}
],
"initialIsOpen": false
},
{
"id": "def-common.MapStateToProps",
"type": "Type",
"label": "MapStateToProps",
"tags": [
"public"
],
"description": [
"\nState container state to component props mapper.\nSee {@link Connect}"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 183
},
"signature": [
"(state: State) => StateProps"
],
"initialIsOpen": false
},
{
"id": "def-common.Middleware",
"type": "Type",
"label": "Middleware",
"tags": [
"public"
],
"description": [
"\nRedux like Middleware"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 117
},
"signature": [
"(store: Pick<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<State, any, {}>, \"getState\" | \"dispatch\">) => (next: (action: ",
"TransitionDescription",
"<string, any[]>) => any) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Dispatch",
"text": "Dispatch"
},
"<",
"TransitionDescription",
"<string, any[]>>"
],
"initialIsOpen": false
},
{
"id": "def-common.MigrateFunction",
"type": "Type",
"label": "MigrateFunction",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 18
},
"signature": [
"(state: FromVersion) => ToVersion"
],
"initialIsOpen": false
},
{
"id": "def-common.MigrateFunctionsObject",
"type": "Type",
"label": "MigrateFunctionsObject",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 23
},
"signature": [
"{ [key: string]: MigrateFunction<SerializableState, SerializableState>; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PersistableStateDefinition",
"type": "Type",
"label": "PersistableStateDefinition",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 90
},
"signature": [
"{ telemetry?: ((state: P, collector: Record<string, any>) => Record<string, any>) | undefined; inject?: ((state: P, references: SavedObjectReference[]) => P) | undefined; extract?: ((state: P) => { state: P; references: SavedObjectReference[]; }) | undefined; migrations?: MigrateFunctionsObject | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PureSelector",
"type": "Type",
"label": "PureSelector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 153
},
"signature": [
"(state: State) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Selector",
"text": "Selector"
},
"<Result, Args>"
],
"initialIsOpen": false
},
{
"id": "def-common.PureSelectorsToSelectors",
"type": "Type",
"label": "PureSelectorsToSelectors",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 169
},
"signature": [
"{ [K in keyof T]: ReturnType<Ensure<Ensure<T[K], PureSelector<any, any, any>>, PureSelector<any, any, any>>>; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PureSelectorToSelector",
"type": "Type",
"label": "PureSelectorToSelector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 163
},
"signature": [
"(args: any) => any"
],
"initialIsOpen": false
},
{
"id": "def-common.Reducer",
"type": "Type",
"label": "Reducer",
"tags": [
"public"
],
"description": [
"\nRedux like Reducer"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 126
},
"signature": [
"(state: State, action: ",
"TransitionDescription",
"<string, any[]>) => State"
],
"initialIsOpen": false
},
{
"id": "def-common.Selector",
"type": "Type",
"label": "Selector",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 149
},
"signature": [
"(args: Args) => Result"
],
"initialIsOpen": false
},
{
"id": "def-common.Serializable",
"type": "Type",
"label": "Serializable",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 12
},
"signature": [
"undefined | null | string | number | false | true | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SerializableState",
"text": "SerializableState"
},
" | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SerializableValue",
"text": "SerializableValue"
},
"[]"
],
"initialIsOpen": false
},
{
"id": "def-common.SerializableState",
"type": "Type",
"label": "SerializableState",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 14
},
"signature": [
"{ [key: string]: Serializable; }"
],
"initialIsOpen": false
},
{
"id": "def-common.SerializableValue",
"type": "Type",
"label": "SerializableValue",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
"lineNumber": 11
},
"signature": [
"undefined | null | string | number | false | true | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SerializableState",
"text": "SerializableState"
}
],
"initialIsOpen": false
},
{
"id": "def-common.Set",
"type": "Type",
"label": "Set",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
"lineNumber": 10
},
"signature": [
"(value: T) => void"
],
"initialIsOpen": false
},
{
"id": "def-common.UiComponent",
"type": "Type",
"label": "UiComponent",
"tags": [],
"description": [
"\nIn many places in Kibana we want to be agnostic to frontend view library,\ni.e. instead of exposing React-specific APIs we want to expose APIs that\nare orthogonal to any rendering library. This interface represents such UI\ncomponents. UI component receives a DOM element and `props` through `render()`\nmethod, the `render()` method can be called many times.\n\nAlthough Kibana aims to be library agnostic, Kibana itself is written in React,\nthus here we define `UiComponent` which is an abstract unit of UI that can be\nimplemented in any framework, but it maps easily to React components, i.e.\n`UiComponent<Props>` is like `React.ComponentType<Props>`."
],
"source": {
"path": "src/plugins/kibana_utils/common/ui/ui_component.ts",
"lineNumber": 21
},
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponentInstance",
"text": "UiComponentInstance"
},
"<Props>"
],
"initialIsOpen": false
},
{
"id": "def-common.UnboxState",
"type": "Type",
"label": "UnboxState",
"tags": [
"public"
],
"description": [
"\nUtility type for inferring state shape from {@link StateContainer}"
],
"source": {
"path": "src/plugins/kibana_utils/common/state_containers/types.ts",
"lineNumber": 135
},
"signature": [
"Container extends StateContainer<infer T, any, {}> ? T : never"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-common.url",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.url.encodeQuery",
"type": "Function",
"label": "encodeQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 12
},
"signature": [
"(query: ",
"ParsedQuery",
"<string>, encodeFunction?: (val: string, pctEncodeSpaces?: boolean | undefined) => string, pctEncodeSpaces?: boolean) => ",
"ParsedQuery",
"<string>"
]
},
{
"tags": [],
"id": "def-common.url.encodeUriQuery",
"type": "Function",
"label": "encodeUriQuery",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 13
},
"signature": [
"typeof ",
"encodeUriQuery"
]
},
{
"tags": [],
"id": "def-common.url.addQueryParam",
"type": "Function",
"label": "addQueryParam",
"description": [],
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 14
},
"signature": [
"(params: string, key: string, value?: string | undefined) => string"
]
}
],
"description": [],
"label": "url",
"source": {
"path": "src/plugins/kibana_utils/common/url/index.ts",
"lineNumber": 11
},
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink