2021-03-04 02:12:24 +01:00
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 25
2021-03-04 02:12:24 +01:00
}
}
] ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 25
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 17
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 25
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 26
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 24
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 40
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
"(data: BatchItemData) => Promise<BatchItemResult>"
]
}
] ,
"source" : {
"path" : "src/plugins/bfetch/server/plugin.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 39
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 18
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 45
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 49
2021-03-04 02:12:24 +01:00
} ,
"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"
]
} ,
{
2021-03-06 16:05:27 +01:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 81
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 44
2021-03-04 02:12:24 +01:00
} ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-server.BfetchServerStart" ,
"type" : "Interface" ,
"label" : "BfetchServerStart" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [ ] ,
"source" : {
"path" : "src/plugins/bfetch/server/plugin.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 94
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 32
2021-03-04 02:12:24 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/bfetch/common/buffer/item_buffer.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 32
2021-03-04 02:12:24 +01:00
}
} ,
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 37
2021-03-04 02:12:24 +01:00
}
} ,
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 44
2021-03-04 02:12:24 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/bfetch/common/buffer/item_buffer.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 44
2021-03-04 02:12:24 +01:00
}
} ,
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 58
2021-03-04 02:12:24 +01:00
}
} ,
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 65
2021-03-04 02:12:24 +01:00
}
}
] ,
"source" : {
"path" : "src/plugins/bfetch/common/buffer/item_buffer.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 29
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 22
2021-03-04 02:12:24 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/bfetch/common/buffer/timed_item_buffer.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 22
2021-03-04 02:12:24 +01:00
}
} ,
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 26
2021-03-04 02:12:24 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/bfetch/common/buffer/timed_item_buffer.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 26
2021-03-04 02:12:24 +01:00
}
} ,
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 34
2021-03-04 02:12:24 +01:00
}
} ,
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 39
2021-03-04 02:12:24 +01:00
}
}
] ,
"source" : {
"path" : "src/plugins/bfetch/common/buffer/timed_item_buffer.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 19
2021-03-04 02:12:24 +01:00
} ,
"initialIsOpen" : false
}
] ,
"functions" : [
2021-03-06 16:05:27 +01:00
{
"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
}
}
] ,
"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
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 11
2021-03-04 02:12:24 +01:00
}
}
] ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 11
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 9
2021-03-04 02:12:24 +01:00
}
}
] ,
"signature" : [
"(text: string) => string"
] ,
"description" : [ ] ,
"label" : "removeLeadingSlash" ,
"source" : {
"path" : "src/plugins/bfetch/common/util/remove_leading_slash.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 9
2021-03-04 02:12:24 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchedFunctionParams" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-03-06 16:05:27 +01:00
"label" : "BatchedFunctionParams" ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "bfetch" ,
"scope" : "common" ,
"docId" : "kibBfetchPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.BatchedFunctionParams" ,
"text" : "BatchedFunctionParams"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<Func, BatchEntry>"
2021-03-04 02:12:24 +01:00
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
2021-03-06 16:05:27 +01:00
"tags" : [ ] ,
"id" : "def-common.BatchedFunctionParams.onCall" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-03-06 16:05:27 +01:00
"label" : "onCall" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/create_batched_function.ts" ,
"lineNumber" : 15
} ,
"signature" : [
"(...args: Parameters<Func>) => [ReturnType<Func>, BatchEntry]"
]
} ,
2021-03-04 02:12:24 +01:00
{
2021-03-06 16:05:27 +01:00
"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"
]
2021-03-04 02:12:24 +01:00
} ,
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchedFunctionParams.flushOnMaxItems" ,
2021-03-04 02:12:24 +01:00
"type" : "number" ,
"label" : "flushOnMaxItems" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/create_batched_function.ts" ,
"lineNumber" : 17
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
"number | undefined"
]
} ,
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchedFunctionParams.maxItemAge" ,
"type" : "number" ,
"label" : "maxItemAge" ,
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/create_batched_function.ts" ,
"lineNumber" : 18
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
2021-03-06 16:05:27 +01:00
"number | undefined"
2021-03-04 02:12:24 +01:00
]
}
] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/create_batched_function.ts" ,
"lineNumber" : 14
2021-03-04 02:12:24 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchRequestData" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-03-06 16:05:27 +01:00
"label" : "BatchRequestData" ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "bfetch" ,
"scope" : "common" ,
"docId" : "kibBfetchPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.BatchRequestData" ,
"text" : "BatchRequestData"
2021-03-04 02:12:24 +01:00
} ,
"<Item>"
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchRequestData.batch" ,
"type" : "Array" ,
"label" : "batch" ,
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/batch.ts" ,
"lineNumber" : 14
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
2021-03-06 16:05:27 +01:00
"Item[]"
2021-03-04 02:12:24 +01:00
]
}
] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/batch.ts" ,
"lineNumber" : 13
2021-03-04 02:12:24 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchResponseItem" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-03-06 16:05:27 +01:00
"label" : "BatchResponseItem" ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "bfetch" ,
"scope" : "common" ,
"docId" : "kibBfetchPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.BatchResponseItem" ,
"text" : "BatchResponseItem"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<Result, Error>"
2021-03-04 02:12:24 +01:00
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchResponseItem.id" ,
"type" : "number" ,
"label" : "id" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/batch.ts" ,
"lineNumber" : 18
}
2021-03-04 02:12:24 +01:00
} ,
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchResponseItem.result" ,
"type" : "Uncategorized" ,
"label" : "result" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/batch.ts" ,
"lineNumber" : 19
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
2021-03-06 16:05:27 +01:00
"Result | undefined"
2021-03-04 02:12:24 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.BatchResponseItem.error" ,
"type" : "Uncategorized" ,
"label" : "error" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/batch.ts" ,
"lineNumber" : 20
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
2021-03-06 16:05:27 +01:00
"Error | undefined"
2021-03-04 02:12:24 +01:00
]
}
] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/batch.ts" ,
"lineNumber" : 17
2021-03-04 02:12:24 +01:00
} ,
"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" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 10
2021-03-04 02:12:24 +01:00
}
}
] ,
"source" : {
"path" : "src/plugins/bfetch/common/batch.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 9
2021-03-04 02:12:24 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 16:05:27 +01:00
"id" : "def-common.ItemBufferParams" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-03-06 16:05:27 +01:00
"label" : "ItemBufferParams" ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "bfetch" ,
"scope" : "common" ,
"docId" : "kibBfetchPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.ItemBufferParams" ,
"text" : "ItemBufferParams"
2021-03-04 02:12:24 +01:00
} ,
"<Item>"
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"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."
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/item_buffer.ts" ,
"lineNumber" : 15
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
2021-03-06 16:05:27 +01:00
"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"
2021-03-04 02:12:24 +01:00
]
}
] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/item_buffer.ts" ,
"lineNumber" : 9
2021-03-04 02:12:24 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 16:05:27 +01:00
"id" : "def-common.StreamingResponseHandler" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-03-06 16:05:27 +01:00
"label" : "StreamingResponseHandler" ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "bfetch" ,
"scope" : "common" ,
"docId" : "kibBfetchPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.StreamingResponseHandler" ,
"text" : "StreamingResponseHandler"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<Payload, Response>"
2021-03-04 02:12:24 +01:00
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
2021-03-06 16:05:27 +01:00
"id" : "def-common.StreamingResponseHandler.getResponseStream" ,
"type" : "Function" ,
"label" : "getResponseStream" ,
"signature" : [
"(payload: Payload) => " ,
"Observable" ,
"<Response>"
] ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"children" : [
{
"type" : "Uncategorized" ,
"label" : "payload" ,
"isRequired" : true ,
"signature" : [
"Payload"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/bfetch/common/streaming/types.ts" ,
"lineNumber" : 12
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/streaming/types.ts" ,
"lineNumber" : 12
2021-03-04 02:12:24 +01:00
}
2021-03-06 16:05:27 +01:00
}
] ,
"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"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<Item> extends " ,
2021-03-04 02:12:24 +01:00
{
2021-03-06 16:05:27 +01:00
"pluginId" : "bfetch" ,
"scope" : "common" ,
"docId" : "kibBfetchPluginApi" ,
"section" : "def-common.ItemBufferParams" ,
"text" : "ItemBufferParams"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<Item>"
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
2021-03-04 02:12:24 +01:00
{
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.TimedItemBufferParams.maxItemAge" ,
"type" : "number" ,
"label" : "maxItemAge" ,
"description" : [
"\nFlushes buffer when oldest item reaches age specified by this parameter,\nin milliseconds."
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/timed_item_buffer.ts" ,
"lineNumber" : 16
2021-03-04 02:12:24 +01:00
} ,
"signature" : [
2021-03-06 16:05:27 +01:00
"number | undefined"
2021-03-04 02:12:24 +01:00
]
}
] ,
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/bfetch/common/buffer/timed_item_buffer.ts" ,
"lineNumber" : 11
2021-03-04 02:12:24 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}