Skip to content

Commit 8ed1ae3

Browse files
authored
[7.x] Replace FetchOptions with ISearchOptions (#76538) (#76612)
* Replace FetchOptions with ISearchOptions (#76538) * Replace FetchOptions with ISearchOptions and update usage * Merge the client and server ISearchOption types into common * docs * Update index.tsx Abort signal * Update index.tsx
1 parent 76df1b6 commit 8ed1ae3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+118
-170
lines changed

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fetchoptions.abortsignal.md

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

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

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fetchoptions.searchstrategyid.md

Lines changed: 0 additions & 11 deletions
This file was deleted.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISearchOptions](./kibana-plugin-plugins-data-public.isearchoptions.md) &gt; [abortSignal](./kibana-plugin-plugins-data-public.isearchoptions.abortsignal.md)
4+
5+
## ISearchOptions.abortSignal property
6+
7+
An `AbortSignal` that allows the caller of `search` to abort a search request.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
abortSignal?: AbortSignal;
13+
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ export interface ISearchOptions
1414

1515
| Property | Type | Description |
1616
| --- | --- | --- |
17-
| [signal](./kibana-plugin-plugins-data-public.isearchoptions.signal.md) | <code>AbortSignal</code> | |
18-
| [strategy](./kibana-plugin-plugins-data-public.isearchoptions.strategy.md) | <code>string</code> | |
17+
| [abortSignal](./kibana-plugin-plugins-data-public.isearchoptions.abortsignal.md) | <code>AbortSignal</code> | An <code>AbortSignal</code> that allows the caller of <code>search</code> to abort a search request. |
18+
| [strategy](./kibana-plugin-plugins-data-public.isearchoptions.strategy.md) | <code>string</code> | Use this option to force using a specific server side search strategy. Leave empty to use the default strategy. |
1919

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchoptions.signal.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchoptions.strategy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## ISearchOptions.strategy property
66

7+
Use this option to force using a specific server side search strategy. Leave empty to use the default strategy.
8+
79
<b>Signature:</b>
810

911
```typescript

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
| [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) | |
5151
| [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) | |
5252
| [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) | |
53-
| [FetchOptions](./kibana-plugin-plugins-data-public.fetchoptions.md) | |
5453
| [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) | |
5554
| [FieldMappingSpec](./kibana-plugin-plugins-data-public.fieldmappingspec.md) | |
5655
| [Filter](./kibana-plugin-plugins-data-public.filter.md) | |
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchOptions](./kibana-plugin-plugins-data-server.isearchoptions.md) &gt; [signal](./kibana-plugin-plugins-data-server.isearchoptions.signal.md)
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchOptions](./kibana-plugin-plugins-data-server.isearchoptions.md) &gt; [abortSignal](./kibana-plugin-plugins-data-server.isearchoptions.abortsignal.md)
44

5-
## ISearchOptions.signal property
5+
## ISearchOptions.abortSignal property
66

77
An `AbortSignal` that allows the caller of `search` to abort a search request.
88

99
<b>Signature:</b>
1010

1111
```typescript
12-
signal?: AbortSignal;
12+
abortSignal?: AbortSignal;
1313
```

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchoptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ export interface ISearchOptions
1414

1515
| Property | Type | Description |
1616
| --- | --- | --- |
17-
| [signal](./kibana-plugin-plugins-data-server.isearchoptions.signal.md) | <code>AbortSignal</code> | An <code>AbortSignal</code> that allows the caller of <code>search</code> to abort a search request. |
18-
| [strategy](./kibana-plugin-plugins-data-server.isearchoptions.strategy.md) | <code>string</code> | |
17+
| [abortSignal](./kibana-plugin-plugins-data-server.isearchoptions.abortsignal.md) | <code>AbortSignal</code> | An <code>AbortSignal</code> that allows the caller of <code>search</code> to abort a search request. |
18+
| [strategy](./kibana-plugin-plugins-data-server.isearchoptions.strategy.md) | <code>string</code> | Use this option to force using a specific server side search strategy. Leave empty to use the default strategy. |
1919

0 commit comments

Comments
 (0)