{ "id": "@kbn/react-hooks", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useAbortableAsync", "type": "Function", "tags": [], "label": "useAbortableAsync", "description": [], "signature": [ "(fn: ({}: { signal: AbortSignal; }) => T | Promise, deps: any[], options: UseAbortableAsyncOptions | undefined) => ", { "pluginId": "@kbn/react-hooks", "scope": "common", "docId": "kibKbnReactHooksPluginApi", "section": "def-common.AbortableAsyncState", "text": "AbortableAsyncState" }, "" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useAbortableAsync.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "({}: { signal: AbortSignal; }) => T | Promise" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useAbortableAsync.$2", "type": "Array", "tags": [], "label": "deps", "description": [], "signature": [ "any[]" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useAbortableAsync.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "UseAbortableAsyncOptions | undefined" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useAbortController", "type": "Function", "tags": [], "label": "useAbortController", "description": [], "signature": [ "() => { signal: AbortSignal; abort: () => void; refresh: () => void; }" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abort_controller/use_abort_controller.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useBoolean", "type": "Function", "tags": [], "label": "useBoolean", "description": [], "signature": [ "(initialValue?: boolean) => ", { "pluginId": "@kbn/react-hooks", "scope": "common", "docId": "kibKbnReactHooksPluginApi", "section": "def-common.UseBooleanResult", "text": "UseBooleanResult" } ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_boolean/use_boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useBoolean.$1", "type": "boolean", "tags": [], "label": "initialValue", "description": [], "signature": [ "boolean" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_boolean/use_boolean.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.useErrorTextStyle", "type": "Function", "tags": [], "label": "useErrorTextStyle", "description": [], "signature": [ "() => ", "SerializedStyles" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_error_text_style/use_error_text_style.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseBooleanHandlers", "type": "Interface", "tags": [], "label": "UseBooleanHandlers", "description": [], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_boolean/use_boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseBooleanHandlers.on", "type": "Function", "tags": [], "label": "on", "description": [], "signature": [ "() => void" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_boolean/use_boolean.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseBooleanHandlers.off", "type": "Function", "tags": [], "label": "off", "description": [], "signature": [ "() => void" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_boolean/use_boolean.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseBooleanHandlers.toggle", "type": "Function", "tags": [], "label": "toggle", "description": [], "signature": [ "(nextValue?: any) => void" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_boolean/use_boolean.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseBooleanHandlers.toggle.$1", "type": "Any", "tags": [], "label": "nextValue", "description": [], "signature": [ "any" ], "path": "node_modules/react-use/lib/useToggle.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.AbortableAsyncState", "type": "Type", "tags": [], "label": "AbortableAsyncState", "description": [], "signature": [ "(T extends Promise ? State : State) & { refresh: () => void; }" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseAbortableAsync", "type": "Type", "tags": [], "label": "UseAbortableAsync", "description": [], "signature": [ "(fn: ({}: { signal: AbortSignal; } & TAdditionalParameters) => T | Promise, deps: any[], options?: (UseAbortableAsyncOptions & TAdditionalOptions) | undefined) => ", { "pluginId": "@kbn/react-hooks", "scope": "common", "docId": "kibKbnReactHooksPluginApi", "section": "def-common.AbortableAsyncState", "text": "AbortableAsyncState" }, "" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseAbortableAsync.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "({}: { signal: AbortSignal; } & TAdditionalParameters) => T | Promise" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseAbortableAsync.$1.$1", "type": "CompoundType", "tags": [], "label": "__0", "description": [], "signature": [ "{ signal: AbortSignal; } & TAdditionalParameters" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseAbortableAsync.$2", "type": "Array", "tags": [], "label": "deps", "description": [], "signature": [ "any[]" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseAbortableAsync.$3", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "(UseAbortableAsyncOptions & TAdditionalOptions) | undefined" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_abortable_async/use_abortable_async.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/react-hooks", "id": "def-common.UseBooleanResult", "type": "Type", "tags": [], "label": "UseBooleanResult", "description": [], "signature": [ "[boolean, ", { "pluginId": "@kbn/react-hooks", "scope": "common", "docId": "kibKbnReactHooksPluginApi", "section": "def-common.UseBooleanHandlers", "text": "UseBooleanHandlers" }, "]" ], "path": "src/platform/packages/shared/kbn-react-hooks/src/use_boolean/use_boolean.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }