* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
1209 lines
40 KiB
JSON
1209 lines
40 KiB
JSON
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/streaming/split.ts#L25"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(delimiter?: string) => (in$: ",
|
|
"Observable",
|
|
"<string>) => ",
|
|
"Observable",
|
|
"<string>"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/streaming/split.ts#L25"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/batching/types.ts#L17"
|
|
},
|
|
"signature": [
|
|
"(payload: Payload, signal: AbortSignal | undefined) => Promise<Result>"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L25"
|
|
},
|
|
"signature": [
|
|
"(params: ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "public",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-public.FetchStreamingParams",
|
|
"text": "FetchStreamingParams"
|
|
},
|
|
") => { xhr: XMLHttpRequest; stream: ",
|
|
"Observable",
|
|
"<string>; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.BfetchPublicContract.batchedFunction",
|
|
"type": "Function",
|
|
"label": "batchedFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/public/plugin.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L26"
|
|
},
|
|
"signature": [
|
|
"<Payload, Result extends object>(params: ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "public",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-public.StreamingBatchedFunctionParams",
|
|
"text": "StreamingBatchedFunctionParams"
|
|
},
|
|
"<Payload, Result>) => ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "public",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-public.BatchedFunc",
|
|
"text": "BatchedFunc"
|
|
},
|
|
"<Payload, Result>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/public/plugin.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L24"
|
|
},
|
|
"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"
|
|
},
|
|
"<BatchItemData, BatchItemResult>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.BatchProcessingRouteParams.onBatchItem",
|
|
"type": "Function",
|
|
"label": "onBatchItem",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/server/plugin.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L40"
|
|
},
|
|
"signature": [
|
|
"(data: BatchItemData) => Promise<BatchItemResult>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/server/plugin.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L39"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/types.ts#L18"
|
|
},
|
|
"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"
|
|
},
|
|
"<P, Q, B, Method>) => ",
|
|
"Observable",
|
|
"<Response> | Promise<",
|
|
"Observable",
|
|
"<Response>>"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L45"
|
|
},
|
|
"signature": [
|
|
"<BatchItemData extends object, BatchItemResult extends object>(path: string, handler: (request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "server",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-server.BatchProcessingRouteParams",
|
|
"text": "BatchProcessingRouteParams"
|
|
},
|
|
"<BatchItemData, BatchItemResult>) => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.BfetchServerSetup.addStreamingResponseRoute",
|
|
"type": "Function",
|
|
"label": "addStreamingResponseRoute",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/server/plugin.ts",
|
|
"lineNumber": 49,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L49"
|
|
},
|
|
"signature": [
|
|
"<Payload, Response>(path: string, params: (request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.StreamingResponseHandler",
|
|
"text": "StreamingResponseHandler"
|
|
},
|
|
"<Payload, Response>) => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [
|
|
"example"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L81"
|
|
},
|
|
"signature": [
|
|
"<Response, P, Q, B, Context extends ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
", Method extends ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RouteMethod",
|
|
"text": "RouteMethod"
|
|
},
|
|
" = any>(streamHandler: ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "server",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-server.StreamingRequestHandler",
|
|
"text": "StreamingRequestHandler"
|
|
},
|
|
"<Response, P, Q, B, Method>) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RequestHandler",
|
|
"text": "RequestHandler"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/server/plugin.ts",
|
|
"lineNumber": 44,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L44"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L94"
|
|
},
|
|
"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"
|
|
},
|
|
"<Item>"
|
|
],
|
|
"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"
|
|
},
|
|
"<Item>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L32"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L32"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L37"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L44"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
|
"lineNumber": 44,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L44"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L58"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L65"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L29"
|
|
},
|
|
"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"
|
|
},
|
|
"<Item> extends ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.ItemBuffer",
|
|
"text": "ItemBuffer"
|
|
},
|
|
"<Item>"
|
|
],
|
|
"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"
|
|
},
|
|
"<Item>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L22"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L22"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L26"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L26"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L39"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L19"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/normalize_error.ts#L11"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"<E extends ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.ErrorLike",
|
|
"text": "ErrorLike"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.ErrorLike",
|
|
"text": "ErrorLike"
|
|
},
|
|
">(err: any) => E"
|
|
],
|
|
"description": [],
|
|
"label": "normalizeError",
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/util/normalize_error.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/normalize_error.ts#L11"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/remove_leading_slash.ts#L9"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(text: string) => string"
|
|
],
|
|
"description": [],
|
|
"label": "removeLeadingSlash",
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/util/remove_leading_slash.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/remove_leading_slash.ts#L9"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
"<Func, BatchEntry>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L22"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"<Func extends Fn, BatchEntry>(params: ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.BatchedFunctionParams",
|
|
"text": "BatchedFunctionParams"
|
|
},
|
|
"<Func, BatchEntry>) => [Func, ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.TimedItemBuffer",
|
|
"text": "TimedItemBuffer"
|
|
},
|
|
"<BatchEntry>]"
|
|
],
|
|
"description": [],
|
|
"label": "createBatchedFunction",
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L21"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-common.StreamingResponseHandler",
|
|
"type": "Interface",
|
|
"label": "StreamingResponseHandler",
|
|
"signature": [
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.StreamingResponseHandler",
|
|
"text": "StreamingResponseHandler"
|
|
},
|
|
"<Payload, Response>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-common.StreamingResponseHandler.getResponseStream",
|
|
"type": "Function",
|
|
"label": "getResponseStream",
|
|
"signature": [
|
|
"(payload: Payload) => ",
|
|
"Observable",
|
|
"<Response>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Uncategorized",
|
|
"label": "payload",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Payload"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/streaming/types.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L12"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/streaming/types.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L12"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/streaming/types.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.ItemBufferParams",
|
|
"type": "Interface",
|
|
"label": "ItemBufferParams",
|
|
"signature": [
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.ItemBufferParams",
|
|
"text": "ItemBufferParams"
|
|
},
|
|
"<Item>"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L15"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L22"
|
|
},
|
|
"signature": [
|
|
"(items: Item[]) => void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L9"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.TimedItemBufferParams",
|
|
"type": "Interface",
|
|
"label": "TimedItemBufferParams",
|
|
"signature": [
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.TimedItemBufferParams",
|
|
"text": "TimedItemBufferParams"
|
|
},
|
|
"<Item> extends ",
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.ItemBufferParams",
|
|
"text": "ItemBufferParams"
|
|
},
|
|
"<Item>"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L16"
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.BatchedFunctionParams",
|
|
"type": "Interface",
|
|
"label": "BatchedFunctionParams",
|
|
"signature": [
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.BatchedFunctionParams",
|
|
"text": "BatchedFunctionParams"
|
|
},
|
|
"<Func, BatchEntry>"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L15"
|
|
},
|
|
"signature": [
|
|
"(...args: Parameters<Func>) => [ReturnType<Func>, 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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L16"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L17"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L18"
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L14"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L10"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/batch.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L9"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.BatchRequestData",
|
|
"type": "Interface",
|
|
"label": "BatchRequestData",
|
|
"signature": [
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.BatchRequestData",
|
|
"text": "BatchRequestData"
|
|
},
|
|
"<Item>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BatchRequestData.batch",
|
|
"type": "Array",
|
|
"label": "batch",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/batch.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L14"
|
|
},
|
|
"signature": [
|
|
"Item[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/batch.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L13"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.BatchResponseItem",
|
|
"type": "Interface",
|
|
"label": "BatchResponseItem",
|
|
"signature": [
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "common",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-common.BatchResponseItem",
|
|
"text": "BatchResponseItem"
|
|
},
|
|
"<Result, Error>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BatchResponseItem.id",
|
|
"type": "number",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/batch.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L18"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BatchResponseItem.result",
|
|
"type": "Uncategorized",
|
|
"label": "result",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/batch.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L19"
|
|
},
|
|
"signature": [
|
|
"Result | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BatchResponseItem.error",
|
|
"type": "Uncategorized",
|
|
"label": "error",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/batch.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L20"
|
|
},
|
|
"signature": [
|
|
"Error | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/bfetch/common/batch.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L17"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |