Skip to content

Commit ef12dfb

Browse files
author
Liza K
committed
Clean up internal docs
1 parent ce4463b commit ef12dfb

15 files changed

+44
-117
lines changed

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.datapublicpluginsetup.__enhance.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.datapublicpluginsetup.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ export interface DataPublicPluginSetup
1414

1515
| Property | Type | Description |
1616
| --- | --- | --- |
17-
| [\_\_enhance](./kibana-plugin-plugins-data-public.datapublicpluginsetup.__enhance.md) | <code>(enhancements: DataPublicPluginEnhancements) =&gt; void</code> | |
1817
| [autocomplete](./kibana-plugin-plugins-data-public.datapublicpluginsetup.autocomplete.md) | <code>AutocompleteSetup</code> | |
1918
| [fieldFormats](./kibana-plugin-plugins-data-public.datapublicpluginsetup.fieldformats.md) | <code>FieldFormatsSetup</code> | |
2019
| [query](./kibana-plugin-plugins-data-public.datapublicpluginsetup.query.md) | <code>QuerySetup</code> | |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.abortcontroller.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.application.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22

33
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) &gt; [getPendingCount$](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md)
44

5-
## SearchInterceptor.getPendingCount$ property
5+
## SearchInterceptor.getPendingCount$() method
66

77
Returns an `Observable` over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses.
88

99
<b>Signature:</b>
1010

1111
```typescript
12-
getPendingCount$: () => Observable<number>;
12+
getPendingCount$(): Observable<number>;
1313
```
14+
<b>Returns:</b>
15+
16+
`Observable<number>`
17+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.hidetoast.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.longrunningtoast.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,14 @@ export declare class SearchInterceptor
2020

2121
| Property | Modifiers | Type | Description |
2222
| --- | --- | --- | --- |
23-
| [abortController](./kibana-plugin-plugins-data-public.searchinterceptor.abortcontroller.md) | | <code>AbortController</code> | <code>abortController</code> used to signal all searches to abort. |
24-
| [application](./kibana-plugin-plugins-data-public.searchinterceptor.application.md) | | <code>CoreStart['application']</code> | |
2523
| [deps](./kibana-plugin-plugins-data-public.searchinterceptor.deps.md) | | <code>SearchInterceptorDeps</code> | |
26-
| [getPendingCount$](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md) | | <code>() =&gt; Observable&lt;number&gt;</code> | Returns an <code>Observable</code> over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses. |
27-
| [hideToast](./kibana-plugin-plugins-data-public.searchinterceptor.hidetoast.md) | | <code>() =&gt; void</code> | |
28-
| [longRunningToast](./kibana-plugin-plugins-data-public.searchinterceptor.longrunningtoast.md) | | <code>Toast</code> | The current long-running toast (if there is one). |
29-
| [pendingCount$](./kibana-plugin-plugins-data-public.searchinterceptor.pendingcount_.md) | | <code>BehaviorSubject&lt;number&gt;</code> | Observable that emits when the number of pending requests changes. |
3024
| [requestTimeout](./kibana-plugin-plugins-data-public.searchinterceptor.requesttimeout.md) | | <code>number &#124; undefined</code> | |
31-
| [showToast](./kibana-plugin-plugins-data-public.searchinterceptor.showtoast.md) | | <code>() =&gt; void</code> | |
32-
| [timeoutSubscriptions](./kibana-plugin-plugins-data-public.searchinterceptor.timeoutsubscriptions.md) | | <code>Subscription</code> | The subscriptions from scheduling the automatic timeout for each request. |
3325

3426
## Methods
3527

3628
| Method | Modifiers | Description |
3729
| --- | --- | --- |
30+
| [getPendingCount$()](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md) | | Returns an <code>Observable</code> over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses. |
3831
| [runSearch(request, signal, strategy)](./kibana-plugin-plugins-data-public.searchinterceptor.runsearch.md) | | |
3932
| [search(request, options)](./kibana-plugin-plugins-data-public.searchinterceptor.search.md) | | Searches using the given <code>search</code> method. Overrides the <code>AbortSignal</code> with one that will abort either when <code>cancelPending</code> is called, when the request times out, or when the original <code>AbortSignal</code> is aborted. Updates <code>pendingCount$</code> when the request is started/finalized. |
4033
| [setupTimers(options)](./kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md) | | |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.pendingcount_.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.showtoast.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)