{ "id": "bfetch", "client": { "classes": [], "functions": [ { "id": "def-public.split", "type": "Function", "children": [ { "type": "string", "label": "delimiter", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/bfetch/public/streaming/split.ts", "lineNumber": 25 } } ], "signature": [ "(delimiter?: string) => (in$: ", "Observable", ") => ", "Observable", "" ], "description": [ "\nReceives observable that emits strings, and returns a new observable\nthat also returns strings separated by delimiter.\n\nInput stream:\n\n asdf.f -> df..aaa. -> dfsdf\n\nOutput stream, assuming \".\" is used as delimiter:\n\n asdf -> fdf -> aaa -> dfsdf\n" ], "label": "split", "source": { "path": "src/plugins/bfetch/public/streaming/split.ts", "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [ { "id": "def-public.BatchedFunc", "type": "Type", "label": "BatchedFunc", "tags": [], "description": [], "source": { "path": "src/plugins/bfetch/public/batching/types.ts", "lineNumber": 17 }, "signature": [ "(payload: Payload, signal: AbortSignal | undefined) => Promise" ], "initialIsOpen": false } ], "objects": [], "start": { "id": "def-public.BfetchPublicContract", "type": "Interface", "label": "BfetchPublicContract", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.BfetchPublicContract.fetchStreaming", "type": "Function", "label": "fetchStreaming", "description": [], "source": { "path": "src/plugins/bfetch/public/plugin.ts", "lineNumber": 25 }, "signature": [ "(params: ", { "pluginId": "bfetch", "scope": "public", "docId": "kibBfetchPluginApi", "section": "def-public.FetchStreamingParams", "text": "FetchStreamingParams" }, ") => { xhr: XMLHttpRequest; stream: ", "Observable", "; }" ] }, { "tags": [], "id": "def-public.BfetchPublicContract.batchedFunction", "type": "Function", "label": "batchedFunction", "description": [], "source": { "path": "src/plugins/bfetch/public/plugin.ts", "lineNumber": 26 }, "signature": [ "(params: ", { "pluginId": "bfetch", "scope": "public", "docId": "kibBfetchPluginApi", "section": "def-public.StreamingBatchedFunctionParams", "text": "StreamingBatchedFunctionParams" }, ") => ", { "pluginId": "bfetch", "scope": "public", "docId": "kibBfetchPluginApi", "section": "def-public.BatchedFunc", "text": "BatchedFunc" }, "" ] } ], "source": { "path": "src/plugins/bfetch/public/plugin.ts", "lineNumber": 24 }, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [ { "id": "def-server.BatchProcessingRouteParams", "type": "Interface", "label": "BatchProcessingRouteParams", "signature": [ { "pluginId": "bfetch", "scope": "server", "docId": "kibBfetchPluginApi", "section": "def-server.BatchProcessingRouteParams", "text": "BatchProcessingRouteParams" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.BatchProcessingRouteParams.onBatchItem", "type": "Function", "label": "onBatchItem", "description": [], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 40 }, "signature": [ "(data: BatchItemData) => Promise" ] } ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 39 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "id": "def-server.StreamingRequestHandler", "type": "Type", "label": "StreamingRequestHandler", "tags": [ "public" ], "description": [ "\nRequest handler modified to allow to return an observable.\n\nSee {@link BfetchServerSetup.createStreamingRequestHandler} for usage example." ], "source": { "path": "src/plugins/bfetch/server/types.ts", "lineNumber": 18 }, "signature": [ "(context: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, ", request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => ", "Observable", " | Promise<", "Observable", ">" ], "initialIsOpen": false } ], "objects": [], "setup": { "id": "def-server.BfetchServerSetup", "type": "Interface", "label": "BfetchServerSetup", "description": [], "tags": [ "public" ], "children": [ { "tags": [], "id": "def-server.BfetchServerSetup.addBatchProcessingRoute", "type": "Function", "label": "addBatchProcessingRoute", "description": [], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 45 }, "signature": [ "(path: string, handler: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => ", { "pluginId": "bfetch", "scope": "server", "docId": "kibBfetchPluginApi", "section": "def-server.BatchProcessingRouteParams", "text": "BatchProcessingRouteParams" }, ") => void" ] }, { "tags": [], "id": "def-server.BfetchServerSetup.addStreamingResponseRoute", "type": "Function", "label": "addStreamingResponseRoute", "description": [], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 49 }, "signature": [ "(path: string, params: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => ", { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.StreamingResponseHandler", "text": "StreamingResponseHandler" }, ") => void" ] }, { "tags": [], "id": "def-server.BfetchServerSetup.createStreamingRequestHandler", "type": "Function", "label": "createStreamingRequestHandler", "description": [ "\nCreate a streaming request handler to be able to use an Observable to return chunked content to the client.\nThis is meant to be used with the `fetchStreaming` API of the `bfetch` client-side plugin.\n" ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 81 }, "signature": [ "(streamHandler: ", { "pluginId": "bfetch", "scope": "server", "docId": "kibBfetchPluginApi", "section": "def-server.StreamingRequestHandler", "text": "StreamingRequestHandler" }, ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" } ] } ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 44 }, "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-server.BfetchServerStart", "type": "Interface", "label": "BfetchServerStart", "description": [], "tags": [], "children": [], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 94 }, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [ { "id": "def-common.ItemBuffer", "type": "Class", "tags": [], "label": "ItemBuffer", "description": [ "\nA simple buffer that collects items. Can be cleared or flushed; and can\nautomatically flush when specified number of items is reached." ], "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.ItemBuffer", "text": "ItemBuffer" }, "" ], "children": [ { "id": "def-common.ItemBuffer.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "params", "isRequired": true, "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.ItemBufferParams", "text": "ItemBufferParams" }, "" ], "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 32 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 32 } }, { "id": "def-common.ItemBuffer.length", "type": "number", "label": "length", "tags": [], "description": [ "\nGet current buffer size." ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 37 } }, { "id": "def-common.ItemBuffer.write", "type": "Function", "label": "write", "signature": [ "(item: Item) => void" ], "description": [ "\nAdd item to the buffer." ], "children": [ { "type": "Uncategorized", "label": "item", "isRequired": true, "signature": [ "Item" ], "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 44 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 44 } }, { "id": "def-common.ItemBuffer.clear", "type": "Function", "label": "clear", "signature": [ "() => void" ], "description": [ "\nRemove all items from the buffer." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 58 } }, { "id": "def-common.ItemBuffer.flush", "type": "Function", "label": "flush", "signature": [ "() => void" ], "description": [ "\nCall `.onflush` method and clear buffer." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 65 } } ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 29 }, "initialIsOpen": false }, { "id": "def-common.TimedItemBuffer", "type": "Class", "tags": [], "label": "TimedItemBuffer", "description": [], "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.TimedItemBuffer", "text": "TimedItemBuffer" }, " extends ", { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.ItemBuffer", "text": "ItemBuffer" }, "" ], "children": [ { "id": "def-common.TimedItemBuffer.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "params", "isRequired": true, "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.TimedItemBufferParams", "text": "TimedItemBufferParams" }, "" ], "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 22 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 22 } }, { "id": "def-common.TimedItemBuffer.write", "type": "Function", "label": "write", "signature": [ "(item: Item) => void" ], "description": [], "children": [ { "type": "Uncategorized", "label": "item", "isRequired": true, "signature": [ "Item" ], "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 26 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 26 } }, { "id": "def-common.TimedItemBuffer.clear", "type": "Function", "label": "clear", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 34 } }, { "id": "def-common.TimedItemBuffer.flush", "type": "Function", "label": "flush", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 39 } } ], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 19 }, "initialIsOpen": false } ], "functions": [ { "id": "def-common.createBatchedFunction", "type": "Function", "children": [ { "type": "Object", "label": "params", "isRequired": true, "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.BatchedFunctionParams", "text": "BatchedFunctionParams" }, "" ], "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 22 } } ], "signature": [ "(params: ", { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.BatchedFunctionParams", "text": "BatchedFunctionParams" }, ") => [Func, ", { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.TimedItemBuffer", "text": "TimedItemBuffer" }, "]" ], "description": [], "label": "createBatchedFunction", "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 21 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.normalizeError", "type": "Function", "children": [ { "type": "Any", "label": "err", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/bfetch/common/util/normalize_error.ts", "lineNumber": 11 } } ], "signature": [ "(err: any) => E" ], "description": [], "label": "normalizeError", "source": { "path": "src/plugins/bfetch/common/util/normalize_error.ts", "lineNumber": 11 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.removeLeadingSlash", "type": "Function", "children": [ { "type": "string", "label": "text", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/bfetch/common/util/remove_leading_slash.ts", "lineNumber": 9 } } ], "signature": [ "(text: string) => string" ], "description": [], "label": "removeLeadingSlash", "source": { "path": "src/plugins/bfetch/common/util/remove_leading_slash.ts", "lineNumber": 9 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-common.BatchedFunctionParams", "type": "Interface", "label": "BatchedFunctionParams", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.BatchedFunctionParams", "text": "BatchedFunctionParams" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.BatchedFunctionParams.onCall", "type": "Function", "label": "onCall", "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 15 }, "signature": [ "(...args: Parameters) => [ReturnType, BatchEntry]" ] }, { "tags": [], "id": "def-common.BatchedFunctionParams.onBatch", "type": "Function", "label": "onBatch", "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 16 }, "signature": [ "(items: BatchEntry[]) => void" ] }, { "tags": [], "id": "def-common.BatchedFunctionParams.flushOnMaxItems", "type": "number", "label": "flushOnMaxItems", "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 17 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.BatchedFunctionParams.maxItemAge", "type": "number", "label": "maxItemAge", "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 18 }, "signature": [ "number | undefined" ] } ], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-common.BatchRequestData", "type": "Interface", "label": "BatchRequestData", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.BatchRequestData", "text": "BatchRequestData" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.BatchRequestData.batch", "type": "Array", "label": "batch", "description": [], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 14 }, "signature": [ "Item[]" ] } ], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 13 }, "initialIsOpen": false }, { "id": "def-common.BatchResponseItem", "type": "Interface", "label": "BatchResponseItem", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.BatchResponseItem", "text": "BatchResponseItem" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.BatchResponseItem.id", "type": "number", "label": "id", "description": [], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-common.BatchResponseItem.result", "type": "Uncategorized", "label": "result", "description": [], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 19 }, "signature": [ "Result | undefined" ] }, { "tags": [], "id": "def-common.BatchResponseItem.error", "type": "Uncategorized", "label": "error", "description": [], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 20 }, "signature": [ "Error | undefined" ] } ], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 17 }, "initialIsOpen": false }, { "id": "def-common.ErrorLike", "type": "Interface", "label": "ErrorLike", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ErrorLike.message", "type": "string", "label": "message", "description": [], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 10 } } ], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 9 }, "initialIsOpen": false }, { "id": "def-common.ItemBufferParams", "type": "Interface", "label": "ItemBufferParams", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.ItemBufferParams", "text": "ItemBufferParams" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ItemBufferParams.flushOnMaxItems", "type": "number", "label": "flushOnMaxItems", "description": [ "\nFlushes buffer automatically if number of items in the buffer reaches\nthis number. Omit it or set to `Infinity` to never flush on max buffer\nsize automatically." ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 15 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.ItemBufferParams.onFlush", "type": "Function", "label": "onFlush", "description": [ "\nCallback that is called every time buffer is flushed. It receives a single\nargument which is a list of all buffered items. If `.flush()` is called\nwhen buffer is empty, `.onflush` is called with empty array." ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 22 }, "signature": [ "(items: Item[]) => void" ] } ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 9 }, "initialIsOpen": false }, { "id": "def-common.StreamingResponseHandler", "type": "Interface", "label": "StreamingResponseHandler", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.StreamingResponseHandler", "text": "StreamingResponseHandler" }, "" ], "description": [], "tags": [], "children": [ { "id": "def-common.StreamingResponseHandler.getResponseStream", "type": "Function", "label": "getResponseStream", "signature": [ "(payload: Payload) => ", "Observable", "" ], "description": [], "children": [ { "type": "Uncategorized", "label": "payload", "isRequired": true, "signature": [ "Payload" ], "description": [], "source": { "path": "src/plugins/bfetch/common/streaming/types.ts", "lineNumber": 12 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/bfetch/common/streaming/types.ts", "lineNumber": 12 } } ], "source": { "path": "src/plugins/bfetch/common/streaming/types.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-common.TimedItemBufferParams", "type": "Interface", "label": "TimedItemBufferParams", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.TimedItemBufferParams", "text": "TimedItemBufferParams" }, " extends ", { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", "section": "def-common.ItemBufferParams", "text": "ItemBufferParams" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.TimedItemBufferParams.maxItemAge", "type": "number", "label": "maxItemAge", "description": [ "\nFlushes buffer when oldest item reaches age specified by this parameter,\nin milliseconds." ], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 16 }, "signature": [ "number | undefined" ] } ], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 11 }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [] } }