github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

chore(NA): upgrades @microsoft-api-* deps to most recent version (#118382)

Browse source 
* chore(NA): upgrades @microsoft-api-* deps to most recent version

* chore(NA): update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Tiago Costa 2021-11-12 00:04:42 +00:00 • committed by GitHub
parent b47e55c492
commit 7fea493396
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
535 changed files with 1796 additions and 1854 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md
View file

@ -44,6 +44,5 @@ core.application.register({
],
mount: () => { ... }
})
```

1
docs/development/core/public/kibana-plugin-core-public.app.exactroute.md
View file

@ -25,6 +25,5 @@ core.application.register({
// '[basePath]/app/my_app' will be matched
// '[basePath]/app/my_app/some/path' will not be matched
```

31
docs/development/core/public/kibana-plugin-core-public.app.md
View file

@ -10,24 +10,25 @@
```typescript
export interface App<HistoryLocationState = unknown> extends AppNavOptions
```
<b>Extends:</b> AppNavOptions
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [appRoute](./kibana-plugin-core-public.app.approute.md) | <code>string</code> | Override the application's routing path from <code>/app/${id}</code>. Must be unique across registered applications. Should not include the base path from HTTP. |
| [capabilities](./kibana-plugin-core-public.app.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
| [category](./kibana-plugin-core-public.app.category.md) | <code>AppCategory</code> | The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
| [chromeless](./kibana-plugin-core-public.app.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
| [deepLinks](./kibana-plugin-core-public.app.deeplinks.md) | <code>AppDeepLink[]</code> | Input type for registering secondary in-app locations for an application.<!-- -->Deep links must include at least one of <code>path</code> or <code>deepLinks</code>. A deep link that does not have a <code>path</code> represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. |
| [defaultPath](./kibana-plugin-core-public.app.defaultpath.md) | <code>string</code> | Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the <code>path</code> option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)<!-- -->\`<!-- -->, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. |
| [exactRoute](./kibana-plugin-core-public.app.exactroute.md) | <code>boolean</code> | If set to true, the application's route will only be checked against an exact match. Defaults to <code>false</code>. |
| [id](./kibana-plugin-core-public.app.id.md) | <code>string</code> | The unique identifier of the application |
| [keywords](./kibana-plugin-core-public.app.keywords.md) | <code>string[]</code> | Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. |
| [mount](./kibana-plugin-core-public.app.mount.md) | <code>AppMount&lt;HistoryLocationState&gt;</code> | A mount function called when the user navigates to this app's route. |
| [navLinkStatus](./kibana-plugin-core-public.app.navlinkstatus.md) | <code>AppNavLinkStatus</code> | The initial status of the application's navLink. Defaulting to <code>visible</code> if <code>status</code> is <code>accessible</code> and <code>hidden</code> if status is <code>inaccessible</code> See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) |
| [searchable](./kibana-plugin-core-public.app.searchable.md) | <code>boolean</code> | The initial flag to determine if the application is searchable in the global search. Defaulting to <code>true</code> if <code>navLinkStatus</code> is <code>visible</code> or omitted. |
| [status](./kibana-plugin-core-public.app.status.md) | <code>AppStatus</code> | The initial status of the application. Defaulting to <code>accessible</code> |
| [title](./kibana-plugin-core-public.app.title.md) | <code>string</code> | The title of the application. |
| [updater$](./kibana-plugin-core-public.app.updater_.md) | <code>Observable&lt;AppUpdater&gt;</code> | An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. |
| [appRoute?](./kibana-plugin-core-public.app.approute.md) | string | <i>(Optional)</i> Override the application's routing path from <code>/app/${id}</code>. Must be unique across registered applications. Should not include the base path from HTTP. |
| [capabilities?](./kibana-plugin-core-public.app.capabilities.md) | Partial&lt;Capabilities&gt; | <i>(Optional)</i> Custom capabilities defined by the app. |
| [category?](./kibana-plugin-core-public.app.category.md) | AppCategory | <i>(Optional)</i> The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
| [chromeless?](./kibana-plugin-core-public.app.chromeless.md) | boolean | <i>(Optional)</i> Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
| [deepLinks?](./kibana-plugin-core-public.app.deeplinks.md) | AppDeepLink\[\] | <i>(Optional)</i> Input type for registering secondary in-app locations for an application.<!-- -->Deep links must include at least one of <code>path</code> or <code>deepLinks</code>. A deep link that does not have a <code>path</code> represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. |
| [defaultPath?](./kibana-plugin-core-public.app.defaultpath.md) | string | <i>(Optional)</i> Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the <code>path</code> option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)<!-- -->\`<!-- -->, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. |
| [exactRoute?](./kibana-plugin-core-public.app.exactroute.md) | boolean | <i>(Optional)</i> If set to true, the application's route will only be checked against an exact match. Defaults to <code>false</code>. |
| [id](./kibana-plugin-core-public.app.id.md) | string | The unique identifier of the application |
| [keywords?](./kibana-plugin-core-public.app.keywords.md) | string\[\] | <i>(Optional)</i> Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. |
| [mount](./kibana-plugin-core-public.app.mount.md) | AppMount&lt;HistoryLocationState&gt; | A mount function called when the user navigates to this app's route. |
| [navLinkStatus?](./kibana-plugin-core-public.app.navlinkstatus.md) | AppNavLinkStatus | <i>(Optional)</i> The initial status of the application's navLink. Defaulting to <code>visible</code> if <code>status</code> is <code>accessible</code> and <code>hidden</code> if status is <code>inaccessible</code> See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) |
| [searchable?](./kibana-plugin-core-public.app.searchable.md) | boolean | <i>(Optional)</i> The initial flag to determine if the application is searchable in the global search. Defaulting to <code>true</code> if <code>navLinkStatus</code> is <code>visible</code> or omitted. |
| [status?](./kibana-plugin-core-public.app.status.md) | AppStatus | <i>(Optional)</i> The initial status of the application. Defaulting to <code>accessible</code> |
| [title](./kibana-plugin-core-public.app.title.md) | string | The title of the application. |
| [updater$?](./kibana-plugin-core-public.app.updater_.md) | Observable&lt;AppUpdater&gt; | <i>(Optional)</i> An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. |

1
docs/development/core/public/kibana-plugin-core-public.app.updater_.md
View file

@ -39,6 +39,5 @@ export class MyPlugin implements Plugin {
navLinkStatus: AppNavLinkStatus.disabled,
})
}
```

10
docs/development/core/public/kibana-plugin-core-public.appcategory.md
View file

@ -16,9 +16,9 @@ export interface AppCategory
| Property | Type | Description |
| --- | --- | --- |
| [ariaLabel](./kibana-plugin-core-public.appcategory.arialabel.md) | <code>string</code> | If the visual label isn't appropriate for screen readers, can override it here |
| [euiIconType](./kibana-plugin-core-public.appcategory.euiicontype.md) | <code>string</code> | Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined |
| [id](./kibana-plugin-core-public.appcategory.id.md) | <code>string</code> | Unique identifier for the categories |
| [label](./kibana-plugin-core-public.appcategory.label.md) | <code>string</code> | Label used for category name. Also used as aria-label if one isn't set. |
| [order](./kibana-plugin-core-public.appcategory.order.md) | <code>number</code> | The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) |
| [ariaLabel?](./kibana-plugin-core-public.appcategory.arialabel.md) | string | <i>(Optional)</i> If the visual label isn't appropriate for screen readers, can override it here |
| [euiIconType?](./kibana-plugin-core-public.appcategory.euiicontype.md) | string | <i>(Optional)</i> Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined |
| [id](./kibana-plugin-core-public.appcategory.id.md) | string | Unique identifier for the categories |
| [label](./kibana-plugin-core-public.appcategory.label.md) | string | Label used for category name. Also used as aria-label if one isn't set. |
| [order?](./kibana-plugin-core-public.appcategory.order.md) | number | <i>(Optional)</i> The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) |

8
docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.md
View file

@ -18,8 +18,8 @@ export interface AppLeaveConfirmAction
| Property | Type | Description |
| --- | --- | --- |
| [callback](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) | <code>() =&gt; void</code> | |
| [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) | <code>string</code> | |
| [title](./kibana-plugin-core-public.appleaveconfirmaction.title.md) | <code>string</code> | |
| [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) | <code>AppLeaveActionType.confirm</code> | |
| [callback?](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) | () =&gt; void | <i>(Optional)</i> |
| [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) | string | |
| [title?](./kibana-plugin-core-public.appleaveconfirmaction.title.md) | string | <i>(Optional)</i> |
| [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) | AppLeaveActionType.confirm | |

2
docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.md
View file

@ -18,5 +18,5 @@ export interface AppLeaveDefaultAction
| Property | Type | Description |
| --- | --- | --- |
| [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) | <code>AppLeaveActionType.default</code> | |
| [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) | AppLeaveActionType.default | |

4
docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md
View file

@ -16,9 +16,9 @@ register<HistoryLocationState = unknown>(app: App<HistoryLocationState>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| app | <code>App&lt;HistoryLocationState&gt;</code> | an [App](./kibana-plugin-core-public.app.md) |
| app | App&lt;HistoryLocationState&gt; | an [App](./kibana-plugin-core-public.app.md) |
<b>Returns:</b>
`void`
void

5
docs/development/core/public/kibana-plugin-core-public.applicationsetup.registerappupdater.md
View file

@ -18,11 +18,11 @@ registerAppUpdater(appUpdater$: Observable<AppUpdater>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| appUpdater$ | <code>Observable&lt;AppUpdater&gt;</code> | |
| appUpdater$ | Observable&lt;AppUpdater&gt; | |
<b>Returns:</b>
`void`
void
## Example
@ -42,6 +42,5 @@ export class MyPlugin implements Plugin {
);
}
}
```

6
docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md
View file

@ -24,10 +24,10 @@ getUrlForApp(appId: string, options?: {
| Parameter | Type | Description |
| --- | --- | --- |
| appId | <code>string</code> | |
| options | <code>{</code><br/><code> path?: string;</code><br/><code> absolute?: boolean;</code><br/><code> deepLinkId?: string;</code><br/><code> }</code> | |
| appId | string | |
| options | { path?: string; absolute?: boolean; deepLinkId?: string; } | |
<b>Returns:</b>
`string`
string

6
docs/development/core/public/kibana-plugin-core-public.applicationstart.md
View file

@ -15,9 +15,9 @@ export interface ApplicationStart
| Property | Type | Description |
| --- | --- | --- |
| [applications$](./kibana-plugin-core-public.applicationstart.applications_.md) | <code>Observable&lt;ReadonlyMap&lt;string, PublicAppInfo&gt;&gt;</code> | Observable emitting the list of currently registered apps and their associated status. |
| [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md) | <code>RecursiveReadonly&lt;Capabilities&gt;</code> | Gets the read-only capabilities. |
| [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md) | <code>Observable&lt;string &#124; undefined&gt;</code> | An observable that emits the current application id and each subsequent id update. |
| [applications$](./kibana-plugin-core-public.applicationstart.applications_.md) | Observable&lt;ReadonlyMap&lt;string, PublicAppInfo&gt;&gt; | Observable emitting the list of currently registered apps and their associated status. |
| [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md) | RecursiveReadonly&lt;Capabilities&gt; | Gets the read-only capabilities. |
| [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md) | Observable&lt;string \| undefined&gt; | An observable that emits the current application id and each subsequent id update. |
## Methods

6
docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md
View file

@ -16,10 +16,10 @@ navigateToApp(appId: string, options?: NavigateToAppOptions): Promise<void>;
| Parameter | Type | Description |
| --- | --- | --- |
| appId | <code>string</code> | |
| options | <code>NavigateToAppOptions</code> | navigation options |
| appId | string | |
| options | NavigateToAppOptions | navigation options |
<b>Returns:</b>
`Promise<void>`
Promise&lt;void&gt;

5
docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md
View file

@ -22,11 +22,11 @@ navigateToUrl(url: string): Promise<void>;
| Parameter | Type | Description |
| --- | --- | --- |
| url | <code>string</code> | an absolute URL, an absolute path or a relative path, to navigate to. |
| url | string | an absolute URL, an absolute path or a relative path, to navigate to. |
<b>Returns:</b>
`Promise<void>`
Promise&lt;void&gt;
## Example
@ -45,6 +45,5 @@ application.navigateToUrl('/app/discover/some-path') // does not include the cur
application.navigateToUrl('/base-path/s/my-space/app/unknown-app/some-path') // unknown application
application.navigateToUrl('../discover') // resolve to `/base-path/s/my-space/discover` which is not a path of a known app.
application.navigateToUrl('../../other-space/discover') // resolve to `/base-path/s/other-space/discover` which is not within the current basePath.
```

2
docs/development/core/public/kibana-plugin-core-public.appmountparameters.appbasepath.md
View file

@ -35,7 +35,6 @@ export class MyPlugin implements Plugin {
});
}
}
```
```ts
@ -58,6 +57,5 @@ export renderApp = ({ appBasePath, element }: AppMountParameters) => {
return () => ReactDOM.unmountComponentAtNode(element);
}
```

2
docs/development/core/public/kibana-plugin-core-public.appmountparameters.history.md
View file

@ -30,7 +30,6 @@ export class MyPlugin implements Plugin {
});
}
}
```
```ts
@ -52,6 +51,5 @@ export renderApp = ({ element, history }: AppMountParameters) => {
return () => ReactDOM.unmountComponentAtNode(element);
}
```

10
docs/development/core/public/kibana-plugin-core-public.appmountparameters.md
View file

@ -15,9 +15,9 @@ export interface AppMountParameters<HistoryLocationState = unknown>
| Property | Type | Description |
| --- | --- | --- |
| [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) | <code>string</code> | The route path for configuring navigation to the application. This string should not include the base path from HTTP. |
| [element](./kibana-plugin-core-public.appmountparameters.element.md) | <code>HTMLElement</code> | The container element to render the application into. |
| [history](./kibana-plugin-core-public.appmountparameters.history.md) | <code>ScopedHistory&lt;HistoryLocationState&gt;</code> | A scoped history instance for your application. Should be used to wire up your applications Router. |
| [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) | <code>(handler: AppLeaveHandler) =&gt; void</code> | A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page.<!-- -->This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url. |
| [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) | <code>(menuMount: MountPoint &#124; undefined) =&gt; void</code> | A function that can be used to set the mount point used to populate the application action container in the chrome header.<!-- -->Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with <code>undefined</code> will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. |
| [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) | string | The route path for configuring navigation to the application. This string should not include the base path from HTTP. |
| [element](./kibana-plugin-core-public.appmountparameters.element.md) | HTMLElement | The container element to render the application into. |
| [history](./kibana-plugin-core-public.appmountparameters.history.md) | ScopedHistory&lt;HistoryLocationState&gt; | A scoped history instance for your application. Should be used to wire up your applications Router. |
| [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) | (handler: AppLeaveHandler) =&gt; void | A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page.<!-- -->This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url. |
| [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) | (menuMount: MountPoint \| undefined) =&gt; void | A function that can be used to set the mount point used to populate the application action container in the chrome header.<!-- -->Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with <code>undefined</code> will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. |

1
docs/development/core/public/kibana-plugin-core-public.appmountparameters.onappleave.md
View file

@ -41,6 +41,5 @@ export renderApp = ({ element, history, onAppLeave }: AppMountParameters) => {
});
return renderApp({ element, history });
}
```

1
docs/development/core/public/kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md
View file

@ -34,6 +34,5 @@ export renderApp = ({ element, history, setHeaderActionMenu }: AppMountParameter
})
return renderApp({ element, history });
}
```

8
docs/development/core/public/kibana-plugin-core-public.appnavoptions.md
View file

@ -16,8 +16,8 @@ export interface AppNavOptions
| Property | Type | Description |
| --- | --- | --- |
| [euiIconType](./kibana-plugin-core-public.appnavoptions.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precedence over the <code>icon</code> property. |
| [icon](./kibana-plugin-core-public.appnavoptions.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
| [order](./kibana-plugin-core-public.appnavoptions.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
| [tooltip](./kibana-plugin-core-public.appnavoptions.tooltip.md) | <code>string</code> | A tooltip shown when hovering over app link. |
| [euiIconType?](./kibana-plugin-core-public.appnavoptions.euiicontype.md) | string | <i>(Optional)</i> A EUI iconType that will be used for the app's icon. This icon takes precedence over the <code>icon</code> property. |
| [icon?](./kibana-plugin-core-public.appnavoptions.icon.md) | string | <i>(Optional)</i> A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
| [order?](./kibana-plugin-core-public.appnavoptions.order.md) | number | <i>(Optional)</i> An ordinal used to sort nav links relative to one another for display. |
| [tooltip?](./kibana-plugin-core-public.appnavoptions.tooltip.md) | string | <i>(Optional)</i> A tooltip shown when hovering over app link. |

4
docs/development/core/public/kibana-plugin-core-public.asyncplugin.md
View file

@ -6,7 +6,7 @@
> Warning: This API is now obsolete.
>
> Asynchronous lifecycles are deprecated, and should be migrated to sync [plugin](./kibana-plugin-core-public.plugin.md)
> Asynchronous lifecycles are deprecated, and should be migrated to sync
>
A plugin with asynchronous lifecycle methods.
@ -23,5 +23,5 @@ export interface AsyncPlugin<TSetup = void, TStart = void, TPluginsSetup extends
| --- | --- |
| [setup(core, plugins)](./kibana-plugin-core-public.asyncplugin.setup.md) | |
| [start(core, plugins)](./kibana-plugin-core-public.asyncplugin.start.md) | |
| [stop()](./kibana-plugin-core-public.asyncplugin.stop.md) | |
| [stop()?](./kibana-plugin-core-public.asyncplugin.stop.md) | <i>(Optional)</i> |

6
docs/development/core/public/kibana-plugin-core-public.asyncplugin.setup.md
View file

@ -14,10 +14,10 @@ setup(core: CoreSetup<TPluginsStart, TStart>, plugins: TPluginsSetup): TSetup |
| Parameter | Type | Description |
| --- | --- | --- |
| core | <code>CoreSetup&lt;TPluginsStart, TStart&gt;</code> | |
| plugins | <code>TPluginsSetup</code> | |
| core | CoreSetup&lt;TPluginsStart, TStart&gt; | |
| plugins | TPluginsSetup | |
<b>Returns:</b>
`TSetup | Promise<TSetup>`
TSetup \| Promise&lt;TSetup&gt;

6
docs/development/core/public/kibana-plugin-core-public.asyncplugin.start.md
View file

@ -14,10 +14,10 @@ start(core: CoreStart, plugins: TPluginsStart): TStart | Promise<TStart>;
| Parameter | Type | Description |
| --- | --- | --- |
| core | <code>CoreStart</code> | |
| plugins | <code>TPluginsStart</code> | |
| core | CoreStart | |
| plugins | TPluginsStart | |
<b>Returns:</b>
`TStart | Promise<TStart>`
TStart \| Promise&lt;TStart&gt;

2
docs/development/core/public/kibana-plugin-core-public.asyncplugin.stop.md
View file

@ -11,5 +11,5 @@ stop?(): void;
```
<b>Returns:</b>
`void`
void

6
docs/development/core/public/kibana-plugin-core-public.capabilities.md
View file

@ -16,7 +16,7 @@ export interface Capabilities
| Property | Type | Description |
| --- | --- | --- |
| [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md) | <code>Record&lt;string, boolean&gt;</code> | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. |
| [management](./kibana-plugin-core-public.capabilities.management.md) | <code>{</code><br/><code> [sectionId: string]: Record&lt;string, boolean&gt;;</code><br/><code> }</code> | Management section capabilities. |
| [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md) | <code>Record&lt;string, boolean&gt;</code> | Navigation link capabilities. |
| [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md) | Record&lt;string, boolean&gt; | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. |
| [management](./kibana-plugin-core-public.capabilities.management.md) | { \[sectionId: string\]: Record&lt;string, boolean&gt;; } | Management section capabilities. |
| [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md) | Record&lt;string, boolean&gt; | Navigation link capabilities. |

6
docs/development/core/public/kibana-plugin-core-public.chromebadge.md
View file

@ -15,7 +15,7 @@ export interface ChromeBadge
| Property | Type | Description |
| --- | --- | --- |
| [iconType](./kibana-plugin-core-public.chromebadge.icontype.md) | <code>IconType</code> | |
| [text](./kibana-plugin-core-public.chromebadge.text.md) | <code>string</code> | |
| [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md) | <code>string</code> | |
| [iconType?](./kibana-plugin-core-public.chromebadge.icontype.md) | IconType | <i>(Optional)</i> |
| [text](./kibana-plugin-core-public.chromebadge.text.md) | string | |
| [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md) | string | |

5
docs/development/core/public/kibana-plugin-core-public.chromedoctitle.change.md
View file

@ -16,11 +16,11 @@ change(newTitle: string | string[]): void;
| Parameter | Type | Description |
| --- | --- | --- |
| newTitle | <code>string &#124; string[]</code> | |
| newTitle | string \| string\[\] | The new title to set, either a string or string array |
<b>Returns:</b>
`void`
void
## Example
@ -29,6 +29,5 @@ How to change the title of the document
```ts
chrome.docTitle.change('My application title')
chrome.docTitle.change(['My application', 'My section'])
```

2
docs/development/core/public/kibana-plugin-core-public.chromedoctitle.md
View file

@ -18,7 +18,6 @@ How to change the title of the document
```ts
chrome.docTitle.change('My application')
```
## Example 2
@ -27,7 +26,6 @@ How to reset the title of the document to it's initial value
```ts
chrome.docTitle.reset()
```
## Methods

2
docs/development/core/public/kibana-plugin-core-public.chromedoctitle.reset.md
View file

@ -13,5 +13,5 @@ reset(): void;
```
<b>Returns:</b>
`void`
void

6
docs/development/core/public/kibana-plugin-core-public.chromehelpextension.md
View file

@ -15,7 +15,7 @@ export interface ChromeHelpExtension
| Property | Type | Description |
| --- | --- | --- |
| [appName](./kibana-plugin-core-public.chromehelpextension.appname.md) | <code>string</code> | Provide your plugin's name to create a header for separation |
| [content](./kibana-plugin-core-public.chromehelpextension.content.md) | <code>(element: HTMLDivElement) =&gt; () =&gt; void</code> | Custom content to occur below the list of links |
| [links](./kibana-plugin-core-public.chromehelpextension.links.md) | <code>ChromeHelpExtensionMenuLink[]</code> | Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button |
| [appName](./kibana-plugin-core-public.chromehelpextension.appname.md) | string | Provide your plugin's name to create a header for separation |
| [content?](./kibana-plugin-core-public.chromehelpextension.content.md) | (element: HTMLDivElement) =&gt; () =&gt; void | <i>(Optional)</i> Custom content to occur below the list of links |
| [links?](./kibana-plugin-core-public.chromehelpextension.links.md) | ChromeHelpExtensionMenuLink\[\] | <i>(Optional)</i> Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button |

7
docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.md
View file

@ -10,12 +10,13 @@
```typescript
export interface ChromeHelpExtensionMenuCustomLink extends ChromeHelpExtensionLinkBase
```
<b>Extends:</b> ChromeHelpExtensionLinkBase
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) | <code>React.ReactNode</code> | Content of the button (in lieu of <code>children</code>) |
| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | <code>string</code> | URL of the link |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | <code>'custom'</code> | Extend EuiButtonEmpty to provide extra functionality |
| [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) | React.ReactNode | Content of the button (in lieu of <code>children</code>) |
| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | string | URL of the link |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | 'custom' | Extend EuiButtonEmpty to provide extra functionality |

5
docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md
View file

@ -10,11 +10,12 @@
```typescript
export interface ChromeHelpExtensionMenuDiscussLink extends ChromeHelpExtensionLinkBase
```
<b>Extends:</b> ChromeHelpExtensionLinkBase
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | <code>string</code> | URL to discuss page. i.e. <code>https://discuss.elastic.co/c/${appName}</code> |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | <code>'discuss'</code> | Creates a generic give feedback link with comment icon |
| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | string | URL to discuss page. i.e. <code>https://discuss.elastic.co/c/${appName}</code> |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | 'discuss' | Creates a generic give feedback link with comment icon |

5
docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md
View file

@ -10,11 +10,12 @@
```typescript
export interface ChromeHelpExtensionMenuDocumentationLink extends ChromeHelpExtensionLinkBase
```
<b>Extends:</b> ChromeHelpExtensionLinkBase
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | <code>string</code> | URL to documentation page. i.e. <code>${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html</code>, |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | <code>'documentation'</code> | Creates a deep-link to app-specific documentation |
| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | string | URL to documentation page. i.e. <code>${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html</code>, |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | 'documentation' | Creates a deep-link to app-specific documentation |

7
docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md
View file

@ -10,12 +10,13 @@
```typescript
export interface ChromeHelpExtensionMenuGitHubLink extends ChromeHelpExtensionLinkBase
```
<b>Extends:</b> ChromeHelpExtensionLinkBase
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | <code>string[]</code> | Include at least one app-specific label to be applied to the new github issue |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | <code>'github'</code> | Creates a link to a new github issue in the Kibana repo |
| [title](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | <code>string</code> | Provides initial text for the title of the issue |
| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | string\[\] | Include at least one app-specific label to be applied to the new github issue |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | 'github' | Creates a link to a new github issue in the Kibana repo |
| [title?](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | string | <i>(Optional)</i> Provides initial text for the title of the issue |

4
docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md
View file

@ -15,6 +15,6 @@ export interface ChromeNavControl
| Property | Type | Description |
| --- | --- | --- |
| [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) | <code>MountPoint</code> | |
| [order](./kibana-plugin-core-public.chromenavcontrol.order.md) | <code>number</code> | |
| [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) | MountPoint | |
| [order?](./kibana-plugin-core-public.chromenavcontrol.order.md) | number | <i>(Optional)</i> |

1
docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md
View file

@ -23,7 +23,6 @@ chrome.navControls.registerLeft({
return () => ReactDOM.unmountComponentAtNode(targetDomElement);
}
})
```
## Methods

4
docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md
View file

@ -16,9 +16,9 @@ registerCenter(navControl: ChromeNavControl): void;
| Parameter | Type | Description |
| --- | --- | --- |
| navControl | <code>ChromeNavControl</code> | |
| navControl | ChromeNavControl | |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md
View file

@ -16,9 +16,9 @@ registerLeft(navControl: ChromeNavControl): void;
| Parameter | Type | Description |
| --- | --- | --- |
| navControl | <code>ChromeNavControl</code> | |
| navControl | ChromeNavControl | |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md
View file

@ -16,9 +16,9 @@ registerRight(navControl: ChromeNavControl): void;
| Parameter | Type | Description |
| --- | --- | --- |
| navControl | <code>ChromeNavControl</code> | |
| navControl | ChromeNavControl | |
<b>Returns:</b>
`void`
void

24
docs/development/core/public/kibana-plugin-core-public.chromenavlink.md
View file

@ -15,16 +15,16 @@ export interface ChromeNavLink
| Property | Type | Description |
| --- | --- | --- |
| [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) | <code>string</code> | The base route used to open the root of an application. |
| [category](./kibana-plugin-core-public.chromenavlink.category.md) | <code>AppCategory</code> | The category the app lives in |
| [disabled](./kibana-plugin-core-public.chromenavlink.disabled.md) | <code>boolean</code> | Disables a link from being clickable. |
| [euiIconType](./kibana-plugin-core-public.chromenavlink.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precedence over the <code>icon</code> property. |
| [hidden](./kibana-plugin-core-public.chromenavlink.hidden.md) | <code>boolean</code> | Hides a link from the navigation. |
| [href](./kibana-plugin-core-public.chromenavlink.href.md) | <code>string</code> | Settled state between <code>url</code>, <code>baseUrl</code>, and <code>active</code> |
| [icon](./kibana-plugin-core-public.chromenavlink.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
| [id](./kibana-plugin-core-public.chromenavlink.id.md) | <code>string</code> | A unique identifier for looking up links. |
| [order](./kibana-plugin-core-public.chromenavlink.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
| [title](./kibana-plugin-core-public.chromenavlink.title.md) | <code>string</code> | The title of the application. |
| [tooltip](./kibana-plugin-core-public.chromenavlink.tooltip.md) | <code>string</code> | A tooltip shown when hovering over an app link. |
| [url](./kibana-plugin-core-public.chromenavlink.url.md) | <code>string</code> | The route used to open the default path and the deep links of an application. |
| [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) | string | The base route used to open the root of an application. |
| [category?](./kibana-plugin-core-public.chromenavlink.category.md) | AppCategory | <i>(Optional)</i> The category the app lives in |
| [disabled?](./kibana-plugin-core-public.chromenavlink.disabled.md) | boolean | <i>(Optional)</i> Disables a link from being clickable. |
| [euiIconType?](./kibana-plugin-core-public.chromenavlink.euiicontype.md) | string | <i>(Optional)</i> A EUI iconType that will be used for the app's icon. This icon takes precedence over the <code>icon</code> property. |
| [hidden?](./kibana-plugin-core-public.chromenavlink.hidden.md) | boolean | <i>(Optional)</i> Hides a link from the navigation. |
| [href](./kibana-plugin-core-public.chromenavlink.href.md) | string | Settled state between <code>url</code>, <code>baseUrl</code>, and <code>active</code> |
| [icon?](./kibana-plugin-core-public.chromenavlink.icon.md) | string | <i>(Optional)</i> A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
| [id](./kibana-plugin-core-public.chromenavlink.id.md) | string | A unique identifier for looking up links. |
| [order?](./kibana-plugin-core-public.chromenavlink.order.md) | number | <i>(Optional)</i> An ordinal used to sort nav links relative to one another for display. |
| [title](./kibana-plugin-core-public.chromenavlink.title.md) | string | The title of the application. |
| [tooltip?](./kibana-plugin-core-public.chromenavlink.tooltip.md) | string | <i>(Optional)</i> A tooltip shown when hovering over an app link. |
| [url](./kibana-plugin-core-public.chromenavlink.url.md) | string | The route used to open the default path and the deep links of an application. |

2
docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md
View file

@ -13,7 +13,7 @@ enableForcedAppSwitcherNavigation(): void;
```
<b>Returns:</b>
`void`
void
## Remarks

4
docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md
View file

@ -16,9 +16,9 @@ get(id: string): ChromeNavLink | undefined;
| Parameter | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | |
| id | string | |
<b>Returns:</b>
`ChromeNavLink | undefined`
ChromeNavLink \| undefined

2
docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md
View file

@ -13,5 +13,5 @@ getAll(): Array<Readonly<ChromeNavLink>>;
```
<b>Returns:</b>
`Array<Readonly<ChromeNavLink>>`
Array&lt;Readonly&lt;ChromeNavLink&gt;&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md
View file

@ -13,5 +13,5 @@ getForceAppSwitcherNavigation$(): Observable<boolean>;
```
<b>Returns:</b>
`Observable<boolean>`
Observable&lt;boolean&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getnavlinks_.md
View file

@ -13,5 +13,5 @@ getNavLinks$(): Observable<Array<Readonly<ChromeNavLink>>>;
```
<b>Returns:</b>
`Observable<Array<Readonly<ChromeNavLink>>>`
Observable&lt;Array&lt;Readonly&lt;ChromeNavLink&gt;&gt;&gt;

4
docs/development/core/public/kibana-plugin-core-public.chromenavlinks.has.md
View file

@ -16,9 +16,9 @@ has(id: string): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | |
| id | string | |
<b>Returns:</b>
`boolean`
boolean

9
docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.add.md
View file

@ -16,19 +16,18 @@ add(link: string, label: string, id: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| link | <code>string</code> | |
| label | <code>string</code> | |
| id | <code>string</code> | |
| link | string | a relative URL to the resource (not including the ) |
| label | string | the label to display in the UI |
| id | string | a unique string used to de-duplicate the recently accessed list. |
<b>Returns:</b>
`void`
void
## Example
```js
chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234');
```

3
docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get.md
View file

@ -13,13 +13,12 @@ get(): ChromeRecentlyAccessedHistoryItem[];
```
<b>Returns:</b>
`ChromeRecentlyAccessedHistoryItem[]`
ChromeRecentlyAccessedHistoryItem\[\]
## Example
```js
chrome.recentlyAccessed.get().forEach(console.log);
```

3
docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get_.md
View file

@ -13,13 +13,12 @@ get$(): Observable<ChromeRecentlyAccessedHistoryItem[]>;
```
<b>Returns:</b>
`Observable<ChromeRecentlyAccessedHistoryItem[]>`
Observable&lt;ChromeRecentlyAccessedHistoryItem\[\]&gt;
## Example
```js
chrome.recentlyAccessed.get$().subscribe(console.log);
```

6
docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md
View file

@ -15,7 +15,7 @@ export interface ChromeRecentlyAccessedHistoryItem
| Property | Type | Description |
| --- | --- | --- |
| [id](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md) | <code>string</code> | |
| [label](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md) | <code>string</code> | |
| [link](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md) | <code>string</code> | |
| [id](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md) | string | |
| [label](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md) | string | |
| [link](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md) | string | |

2
docs/development/core/public/kibana-plugin-core-public.chromestart.getbadge_.md
View file

@ -13,5 +13,5 @@ getBadge$(): Observable<ChromeBadge | undefined>;
```
<b>Returns:</b>
`Observable<ChromeBadge | undefined>`
Observable&lt;ChromeBadge \| undefined&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbs_.md
View file

@ -13,5 +13,5 @@ getBreadcrumbs$(): Observable<ChromeBreadcrumb[]>;
```
<b>Returns:</b>
`Observable<ChromeBreadcrumb[]>`
Observable&lt;ChromeBreadcrumb\[\]&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md
View file

@ -13,5 +13,5 @@ getBreadcrumbsAppendExtension$(): Observable<ChromeBreadcrumbsAppendExtension |
```
<b>Returns:</b>
`Observable<ChromeBreadcrumbsAppendExtension | undefined>`
Observable&lt;ChromeBreadcrumbsAppendExtension \| undefined&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromestart.getcustomnavlink_.md
View file

@ -13,5 +13,5 @@ getCustomNavLink$(): Observable<Partial<ChromeNavLink> | undefined>;
```
<b>Returns:</b>
`Observable<Partial<ChromeNavLink> | undefined>`
Observable&lt;Partial&lt;ChromeNavLink&gt; \| undefined&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromestart.gethelpextension_.md
View file

@ -13,5 +13,5 @@ getHelpExtension$(): Observable<ChromeHelpExtension | undefined>;
```
<b>Returns:</b>
`Observable<ChromeHelpExtension | undefined>`
Observable&lt;ChromeHelpExtension \| undefined&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md
View file

@ -13,5 +13,5 @@ getIsNavDrawerLocked$(): Observable<boolean>;
```
<b>Returns:</b>
`Observable<boolean>`
Observable&lt;boolean&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromestart.getisvisible_.md
View file

@ -13,5 +13,5 @@ getIsVisible$(): Observable<boolean>;
```
<b>Returns:</b>
`Observable<boolean>`
Observable&lt;boolean&gt;

2
docs/development/core/public/kibana-plugin-core-public.chromestart.hasheaderbanner_.md
View file

@ -13,5 +13,5 @@ hasHeaderBanner$(): Observable<boolean>;
```
<b>Returns:</b>
`Observable<boolean>`
Observable&lt;boolean&gt;

10
docs/development/core/public/kibana-plugin-core-public.chromestart.md
View file

@ -22,7 +22,6 @@ How to add a recently accessed item to the sidebar:
```ts
core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234');
```
## Example 2
@ -34,17 +33,16 @@ core.chrome.setHelpExtension(elem => {
ReactDOM.render(<MyHelpComponent />, elem);
return () => ReactDOM.unmountComponentAtNode(elem);
});
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [docTitle](./kibana-plugin-core-public.chromestart.doctitle.md) | <code>ChromeDocTitle</code> | APIs for accessing and updating the document title. |
| [navControls](./kibana-plugin-core-public.chromestart.navcontrols.md) | <code>ChromeNavControls</code> | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. |
| [navLinks](./kibana-plugin-core-public.chromestart.navlinks.md) | <code>ChromeNavLinks</code> | [APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. |
| [recentlyAccessed](./kibana-plugin-core-public.chromestart.recentlyaccessed.md) | <code>ChromeRecentlyAccessed</code> | [APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. |
| [docTitle](./kibana-plugin-core-public.chromestart.doctitle.md) | ChromeDocTitle | APIs for accessing and updating the document title. |
| [navControls](./kibana-plugin-core-public.chromestart.navcontrols.md) | ChromeNavControls | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. |
| [navLinks](./kibana-plugin-core-public.chromestart.navlinks.md) | ChromeNavLinks | [APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. |
| [recentlyAccessed](./kibana-plugin-core-public.chromestart.recentlyaccessed.md) | ChromeRecentlyAccessed | [APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. |
## Methods

4
docs/development/core/public/kibana-plugin-core-public.chromestart.setbadge.md
View file

@ -16,9 +16,9 @@ setBadge(badge?: ChromeBadge): void;
| Parameter | Type | Description |
| --- | --- | --- |
| badge | <code>ChromeBadge</code> | |
| badge | ChromeBadge | |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbs.md
View file

@ -16,9 +16,9 @@ setBreadcrumbs(newBreadcrumbs: ChromeBreadcrumb[]): void;
| Parameter | Type | Description |
| --- | --- | --- |
| newBreadcrumbs | <code>ChromeBreadcrumb[]</code> | |
| newBreadcrumbs | ChromeBreadcrumb\[\] | |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md
View file

@ -16,9 +16,9 @@ setBreadcrumbsAppendExtension(breadcrumbsAppendExtension?: ChromeBreadcrumbsAppe
| Parameter | Type | Description |
| --- | --- | --- |
| breadcrumbsAppendExtension | <code>ChromeBreadcrumbsAppendExtension</code> | |
| breadcrumbsAppendExtension | ChromeBreadcrumbsAppendExtension | |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromestart.setcustomnavlink.md
View file

@ -16,9 +16,9 @@ setCustomNavLink(newCustomNavLink?: Partial<ChromeNavLink>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| newCustomNavLink | <code>Partial&lt;ChromeNavLink&gt;</code> | |
| newCustomNavLink | Partial&lt;ChromeNavLink&gt; | |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromestart.setheaderbanner.md
View file

@ -16,11 +16,11 @@ setHeaderBanner(headerBanner?: ChromeUserBanner): void;
| Parameter | Type | Description |
| --- | --- | --- |
| headerBanner | <code>ChromeUserBanner</code> | |
| headerBanner | ChromeUserBanner | |
<b>Returns:</b>
`void`
void
## Remarks

4
docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpextension.md
View file

@ -16,9 +16,9 @@ setHelpExtension(helpExtension?: ChromeHelpExtension): void;
| Parameter | Type | Description |
| --- | --- | --- |
| helpExtension | <code>ChromeHelpExtension</code> | |
| helpExtension | ChromeHelpExtension | |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpsupporturl.md
View file

@ -16,9 +16,9 @@ setHelpSupportUrl(url: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| url | <code>string</code> | |
| url | string | The updated support URL |
<b>Returns:</b>
`void`
void

4
docs/development/core/public/kibana-plugin-core-public.chromestart.setisvisible.md
View file

@ -16,9 +16,9 @@ setIsVisible(isVisible: boolean): void;
| Parameter | Type | Description |
| --- | --- | --- |
| isVisible | <code>boolean</code> | |
| isVisible | boolean | |
<b>Returns:</b>
`void`
void

2
docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.md
View file

@ -15,5 +15,5 @@ export interface ChromeUserBanner
| Property | Type | Description |
| --- | --- | --- |
| [content](./kibana-plugin-core-public.chromeuserbanner.content.md) | <code>MountPoint&lt;HTMLDivElement&gt;</code> | |
| [content](./kibana-plugin-core-public.chromeuserbanner.content.md) | MountPoint&lt;HTMLDivElement&gt; | |

14
docs/development/core/public/kibana-plugin-core-public.coresetup.md
View file

@ -16,11 +16,11 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
| Property | Type | Description |
| --- | --- | --- |
| [application](./kibana-plugin-core-public.coresetup.application.md) | <code>ApplicationSetup</code> | [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) |
| [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) |
| [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) | <code>StartServicesAccessor&lt;TPluginsStart, TStart&gt;</code> | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) |
| [http](./kibana-plugin-core-public.coresetup.http.md) | <code>HttpSetup</code> | [HttpSetup](./kibana-plugin-core-public.httpsetup.md) |
| [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) | <code>{</code><br/><code> getInjectedVar: (name: string, defaultValue?: any) =&gt; unknown;</code><br/><code> }</code> | exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform. |
| [notifications](./kibana-plugin-core-public.coresetup.notifications.md) | <code>NotificationsSetup</code> | [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) |
| [uiSettings](./kibana-plugin-core-public.coresetup.uisettings.md) | <code>IUiSettingsClient</code> | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) |
| [application](./kibana-plugin-core-public.coresetup.application.md) | ApplicationSetup | [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) |
| [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) | FatalErrorsSetup | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) |
| [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) | StartServicesAccessor&lt;TPluginsStart, TStart&gt; | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) |
| [http](./kibana-plugin-core-public.coresetup.http.md) | HttpSetup | [HttpSetup](./kibana-plugin-core-public.httpsetup.md) |
| [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) | { getInjectedVar: (name: string, defaultValue?: any) =&gt; unknown; } | exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform. |
| [notifications](./kibana-plugin-core-public.coresetup.notifications.md) | NotificationsSetup | [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) |
| [uiSettings](./kibana-plugin-core-public.coresetup.uisettings.md) | IUiSettingsClient | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) |

24
docs/development/core/public/kibana-plugin-core-public.corestart.md
View file

@ -16,16 +16,16 @@ export interface CoreStart
| Property | Type | Description |
| --- | --- | --- |
| [application](./kibana-plugin-core-public.corestart.application.md) | <code>ApplicationStart</code> | [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) |
| [chrome](./kibana-plugin-core-public.corestart.chrome.md) | <code>ChromeStart</code> | [ChromeStart](./kibana-plugin-core-public.chromestart.md) |
| [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) | <code>DeprecationsServiceStart</code> | [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) |
| [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) | <code>DocLinksStart</code> | [DocLinksStart](./kibana-plugin-core-public.doclinksstart.md) |
| [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) | <code>FatalErrorsStart</code> | [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) |
| [http](./kibana-plugin-core-public.corestart.http.md) | <code>HttpStart</code> | [HttpStart](./kibana-plugin-core-public.httpstart.md) |
| [i18n](./kibana-plugin-core-public.corestart.i18n.md) | <code>I18nStart</code> | [I18nStart](./kibana-plugin-core-public.i18nstart.md) |
| [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) | <code>{</code><br/><code> getInjectedVar: (name: string, defaultValue?: any) =&gt; unknown;</code><br/><code> }</code> | exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform. |
| [notifications](./kibana-plugin-core-public.corestart.notifications.md) | <code>NotificationsStart</code> | [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) |
| [overlays](./kibana-plugin-core-public.corestart.overlays.md) | <code>OverlayStart</code> | [OverlayStart](./kibana-plugin-core-public.overlaystart.md) |
| [savedObjects](./kibana-plugin-core-public.corestart.savedobjects.md) | <code>SavedObjectsStart</code> | [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) |
| [uiSettings](./kibana-plugin-core-public.corestart.uisettings.md) | <code>IUiSettingsClient</code> | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) |
| [application](./kibana-plugin-core-public.corestart.application.md) | ApplicationStart | [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) |
| [chrome](./kibana-plugin-core-public.corestart.chrome.md) | ChromeStart | [ChromeStart](./kibana-plugin-core-public.chromestart.md) |
| [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) | DeprecationsServiceStart | [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) |
| [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) | DocLinksStart | [DocLinksStart](./kibana-plugin-core-public.doclinksstart.md) |
| [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) | FatalErrorsStart | [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) |
| [http](./kibana-plugin-core-public.corestart.http.md) | HttpStart | [HttpStart](./kibana-plugin-core-public.httpstart.md) |
| [i18n](./kibana-plugin-core-public.corestart.i18n.md) | I18nStart | [I18nStart](./kibana-plugin-core-public.i18nstart.md) |
| [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) | { getInjectedVar: (name: string, defaultValue?: any) =&gt; unknown; } | exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform. |
| [notifications](./kibana-plugin-core-public.corestart.notifications.md) | NotificationsStart | [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) |
| [overlays](./kibana-plugin-core-public.corestart.overlays.md) | OverlayStart | [OverlayStart](./kibana-plugin-core-public.overlaystart.md) |
| [savedObjects](./kibana-plugin-core-public.corestart.savedobjects.md) | SavedObjectsStart | [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) |
| [uiSettings](./kibana-plugin-core-public.corestart.uisettings.md) | IUiSettingsClient | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) |

8
docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md
View file

@ -16,8 +16,8 @@ export interface DeprecationsServiceStart
| Property | Type | Description |
| --- | --- | --- |
| [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md) | <code>() =&gt; Promise&lt;DomainDeprecationDetails[]&gt;</code> | Grabs deprecations details for all domains. |
| [getDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md) | <code>(domainId: string) =&gt; Promise&lt;DomainDeprecationDetails[]&gt;</code> | Grabs deprecations for a specific domain. |
| [isDeprecationResolvable](./kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md) | <code>(details: DomainDeprecationDetails) =&gt; boolean</code> | Returns a boolean if the provided deprecation can be automatically resolvable. |
| [resolveDeprecation](./kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md) | <code>(details: DomainDeprecationDetails) =&gt; Promise&lt;ResolveDeprecationResponse&gt;</code> | Calls the correctiveActions.api to automatically resolve the depprecation. |
| [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md) | () =&gt; Promise&lt;DomainDeprecationDetails\[\]&gt; | Grabs deprecations details for all domains. |
| [getDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md) | (domainId: string) =&gt; Promise&lt;DomainDeprecationDetails\[\]&gt; | Grabs deprecations for a specific domain. |
| [isDeprecationResolvable](./kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md) | (details: DomainDeprecationDetails) =&gt; boolean | Returns a boolean if the provided deprecation can be automatically resolvable. |
| [resolveDeprecation](./kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md) | (details: DomainDeprecationDetails) =&gt; Promise&lt;ResolveDeprecationResponse&gt; | Calls the correctiveActions.api to automatically resolve the depprecation. |

6
docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
View file

File diff suppressed because one or more lines are too long

5
docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md
View file

@ -11,11 +11,12 @@ Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error AP
```typescript
export interface ErrorToastOptions extends ToastOptions
```
<b>Extends:</b> ToastOptions
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [title](./kibana-plugin-core-public.errortoastoptions.title.md) | <code>string</code> | The title of the toast and the dialog when expanding the message. |
| [toastMessage](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) | <code>string</code> | The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. |
| [title](./kibana-plugin-core-public.errortoastoptions.title.md) | string | The title of the toast and the dialog when expanding the message. |
| [toastMessage?](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) | string | <i>(Optional)</i> The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. |

4
docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md
View file

@ -16,6 +16,6 @@ export interface FatalErrorInfo
| Property | Type | Description |
| --- | --- | --- |
| [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) | <code>string</code> | |
| [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) | <code>string &#124; undefined</code> | |
| [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) | string | |
| [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) | string \| undefined | |

4
docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.md
View file

@ -16,6 +16,6 @@ export interface FatalErrorsSetup
| Property | Type | Description |
| --- | --- | --- |
| [add](./kibana-plugin-core-public.fatalerrorssetup.add.md) | <code>(error: string &#124; Error, source?: string) =&gt; never</code> | Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. |
| [get$](./kibana-plugin-core-public.fatalerrorssetup.get_.md) | <code>() =&gt; Rx.Observable&lt;FatalErrorInfo&gt;</code> | An Observable that will emit whenever a fatal error is added with <code>add()</code> |
| [add](./kibana-plugin-core-public.fatalerrorssetup.add.md) | (error: string \| Error, source?: string) =&gt; never | Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. |
| [get$](./kibana-plugin-core-public.fatalerrorssetup.get_.md) | () =&gt; Rx.Observable&lt;FatalErrorInfo&gt; | An Observable that will emit whenever a fatal error is added with <code>add()</code> |

13
docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md
View file

@ -11,15 +11,16 @@ All options that may be used with a [HttpHandler](./kibana-plugin-core-public.ht
```typescript
export interface HttpFetchOptions extends HttpRequestInit
```
<b>Extends:</b> HttpRequestInit
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [asResponse](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) | <code>boolean</code> | When <code>true</code> the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When <code>false</code>, the return type will just be the parsed response body. Defaults to <code>false</code>. |
| [asSystemRequest](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) | <code>boolean</code> | Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to <code>false</code>. |
| [context](./kibana-plugin-core-public.httpfetchoptions.context.md) | <code>KibanaExecutionContext</code> | |
| [headers](./kibana-plugin-core-public.httpfetchoptions.headers.md) | <code>HttpHeadersInit</code> | Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md)<!-- -->. |
| [prependBasePath](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) | <code>boolean</code> | Whether or not the request should automatically prepend the basePath. Defaults to <code>true</code>. |
| [query](./kibana-plugin-core-public.httpfetchoptions.query.md) | <code>HttpFetchQuery</code> | The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md)<!-- -->. |
| [asResponse?](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) | boolean | <i>(Optional)</i> When <code>true</code> the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When <code>false</code>, the return type will just be the parsed response body. Defaults to <code>false</code>. |
| [asSystemRequest?](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) | boolean | <i>(Optional)</i> Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to <code>false</code>. |
| [context?](./kibana-plugin-core-public.httpfetchoptions.context.md) | KibanaExecutionContext | <i>(Optional)</i> |
| [headers?](./kibana-plugin-core-public.httpfetchoptions.headers.md) | HttpHeadersInit | <i>(Optional)</i> Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md)<!-- -->. |
| [prependBasePath?](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) | boolean | <i>(Optional)</i> Whether or not the request should automatically prepend the basePath. Defaults to <code>true</code>. |
| [query?](./kibana-plugin-core-public.httpfetchoptions.query.md) | HttpFetchQuery | <i>(Optional)</i> The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md)<!-- -->. |

3
docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md
View file

@ -11,10 +11,11 @@ Similar to [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) b
```typescript
export interface HttpFetchOptionsWithPath extends HttpFetchOptions
```
<b>Extends:</b> HttpFetchOptions
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) | <code>string</code> | |
| [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) | string | |

8
docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md
View file

@ -16,8 +16,8 @@ export interface HttpInterceptor
| Method | Description |
| --- | --- |
| [request(fetchOptions, controller)](./kibana-plugin-core-public.httpinterceptor.request.md) | Define an interceptor to be executed before a request is sent. |
| [requestError(httpErrorRequest, controller)](./kibana-plugin-core-public.httpinterceptor.requesterror.md) | Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. |
| [response(httpResponse, controller)](./kibana-plugin-core-public.httpinterceptor.response.md) | Define an interceptor to be executed after a response is received. |
| [responseError(httpErrorResponse, controller)](./kibana-plugin-core-public.httpinterceptor.responseerror.md) | Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. |
| [request(fetchOptions, controller)?](./kibana-plugin-core-public.httpinterceptor.request.md) | <i>(Optional)</i> Define an interceptor to be executed before a request is sent. |
| [requestError(httpErrorRequest, controller)?](./kibana-plugin-core-public.httpinterceptor.requesterror.md) | <i>(Optional)</i> Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. |
| [response(httpResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.response.md) | <i>(Optional)</i> Define an interceptor to be executed after a response is received. |
| [responseError(httpErrorResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.responseerror.md) | <i>(Optional)</i> Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. |

6
docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md
View file

@ -16,10 +16,10 @@ request?(fetchOptions: Readonly<HttpFetchOptionsWithPath>, controller: IHttpInte
| Parameter | Type | Description |
| --- | --- | --- |
| fetchOptions | <code>Readonly&lt;HttpFetchOptionsWithPath&gt;</code> | |
| controller | <code>IHttpInterceptController</code> | |
| fetchOptions | Readonly&lt;HttpFetchOptionsWithPath&gt; | |
| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) |
<b>Returns:</b>
`MaybePromise<Partial<HttpFetchOptionsWithPath>> | void`
MaybePromise&lt;Partial&lt;HttpFetchOptionsWithPath&gt;&gt; \| void

6
docs/development/core/public/kibana-plugin-core-public.httpinterceptor.requesterror.md
View file

@ -16,10 +16,10 @@ requestError?(httpErrorRequest: HttpInterceptorRequestError, controller: IHttpIn
| Parameter | Type | Description |
| --- | --- | --- |
| httpErrorRequest | <code>HttpInterceptorRequestError</code> | |
| controller | <code>IHttpInterceptController</code> | |
| httpErrorRequest | HttpInterceptorRequestError | [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) |
| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) |
<b>Returns:</b>
`MaybePromise<Partial<HttpFetchOptionsWithPath>> | void`
MaybePromise&lt;Partial&lt;HttpFetchOptionsWithPath&gt;&gt; \| void

6
docs/development/core/public/kibana-plugin-core-public.httpinterceptor.response.md
View file

@ -16,10 +16,10 @@ response?(httpResponse: HttpResponse, controller: IHttpInterceptController): May
| Parameter | Type | Description |
| --- | --- | --- |
| httpResponse | <code>HttpResponse</code> | |
| controller | <code>IHttpInterceptController</code> | |
| httpResponse | HttpResponse | [HttpResponse](./kibana-plugin-core-public.httpresponse.md) |
| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) |
<b>Returns:</b>
`MaybePromise<IHttpResponseInterceptorOverrides> | void`
MaybePromise&lt;IHttpResponseInterceptorOverrides&gt; \| void

6
docs/development/core/public/kibana-plugin-core-public.httpinterceptor.responseerror.md
View file

@ -16,10 +16,10 @@ responseError?(httpErrorResponse: HttpInterceptorResponseError, controller: IHtt
| Parameter | Type | Description |
| --- | --- | --- |
| httpErrorResponse | <code>HttpInterceptorResponseError</code> | |
| controller | <code>IHttpInterceptController</code> | |
| httpErrorResponse | HttpInterceptorResponseError | [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) |
| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) |
<b>Returns:</b>
`MaybePromise<IHttpResponseInterceptorOverrides> | void`
MaybePromise&lt;IHttpResponseInterceptorOverrides&gt; \| void

4
docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.md
View file

@ -15,6 +15,6 @@ export interface HttpInterceptorRequestError
| Property | Type | Description |
| --- | --- | --- |
| [error](./kibana-plugin-core-public.httpinterceptorrequesterror.error.md) | <code>Error</code> | |
| [fetchOptions](./kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md) | <code>Readonly&lt;HttpFetchOptionsWithPath&gt;</code> | |
| [error](./kibana-plugin-core-public.httpinterceptorrequesterror.error.md) | Error | |
| [fetchOptions](./kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md) | Readonly&lt;HttpFetchOptionsWithPath&gt; | |

5
docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.md
View file

@ -10,11 +10,12 @@
```typescript
export interface HttpInterceptorResponseError extends HttpResponse
```
<b>Extends:</b> HttpResponse
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [error](./kibana-plugin-core-public.httpinterceptorresponseerror.error.md) | <code>Error &#124; IHttpFetchError</code> | |
| [request](./kibana-plugin-core-public.httpinterceptorresponseerror.request.md) | <code>Readonly&lt;Request&gt;</code> | |
| [error](./kibana-plugin-core-public.httpinterceptorresponseerror.error.md) | Error \| IHttpFetchError | |
| [request](./kibana-plugin-core-public.httpinterceptorresponseerror.request.md) | Readonly&lt;Request&gt; | |

26
docs/development/core/public/kibana-plugin-core-public.httprequestinit.md
View file

@ -16,17 +16,17 @@ export interface HttpRequestInit
| Property | Type | Description |
| --- | --- | --- |
| [body](./kibana-plugin-core-public.httprequestinit.body.md) | <code>BodyInit &#124; null</code> | A BodyInit object or null to set request's body. |
| [cache](./kibana-plugin-core-public.httprequestinit.cache.md) | <code>RequestCache</code> | The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. |
| [credentials](./kibana-plugin-core-public.httprequestinit.credentials.md) | <code>RequestCredentials</code> | The credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. |
| [headers](./kibana-plugin-core-public.httprequestinit.headers.md) | <code>HttpHeadersInit</code> | [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) |
| [integrity](./kibana-plugin-core-public.httprequestinit.integrity.md) | <code>string</code> | Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. |
| [keepalive](./kibana-plugin-core-public.httprequestinit.keepalive.md) | <code>boolean</code> | Whether or not request can outlive the global in which it was created. |
| [method](./kibana-plugin-core-public.httprequestinit.method.md) | <code>string</code> | HTTP method, which is "GET" by default. |
| [mode](./kibana-plugin-core-public.httprequestinit.mode.md) | <code>RequestMode</code> | The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. |
| [redirect](./kibana-plugin-core-public.httprequestinit.redirect.md) | <code>RequestRedirect</code> | The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. |
| [referrer](./kibana-plugin-core-public.httprequestinit.referrer.md) | <code>string</code> | The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the <code>Referer</code> header of the request being made. |
| [referrerPolicy](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) | <code>ReferrerPolicy</code> | The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. |
| [signal](./kibana-plugin-core-public.httprequestinit.signal.md) | <code>AbortSignal &#124; null</code> | Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. |
| [window](./kibana-plugin-core-public.httprequestinit.window.md) | <code>null</code> | Can only be null. Used to disassociate request from any Window. |
| [body?](./kibana-plugin-core-public.httprequestinit.body.md) | BodyInit \| null | <i>(Optional)</i> A BodyInit object or null to set request's body. |
| [cache?](./kibana-plugin-core-public.httprequestinit.cache.md) | RequestCache | <i>(Optional)</i> The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. |
| [credentials?](./kibana-plugin-core-public.httprequestinit.credentials.md) | RequestCredentials | <i>(Optional)</i> The credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. |
| [headers?](./kibana-plugin-core-public.httprequestinit.headers.md) | HttpHeadersInit | <i>(Optional)</i> [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) |
| [integrity?](./kibana-plugin-core-public.httprequestinit.integrity.md) | string | <i>(Optional)</i> Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. |
| [keepalive?](./kibana-plugin-core-public.httprequestinit.keepalive.md) | boolean | <i>(Optional)</i> Whether or not request can outlive the global in which it was created. |
| [method?](./kibana-plugin-core-public.httprequestinit.method.md) | string | <i>(Optional)</i> HTTP method, which is "GET" by default. |
| [mode?](./kibana-plugin-core-public.httprequestinit.mode.md) | RequestMode | <i>(Optional)</i> The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. |
| [redirect?](./kibana-plugin-core-public.httprequestinit.redirect.md) | RequestRedirect | <i>(Optional)</i> The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. |
| [referrer?](./kibana-plugin-core-public.httprequestinit.referrer.md) | string | <i>(Optional)</i> The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the <code>Referer</code> header of the request being made. |
| [referrerPolicy?](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) | ReferrerPolicy | <i>(Optional)</i> The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. |
| [signal?](./kibana-plugin-core-public.httprequestinit.signal.md) | AbortSignal \| null | <i>(Optional)</i> Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. |
| [window?](./kibana-plugin-core-public.httprequestinit.window.md) | null | <i>(Optional)</i> Can only be null. Used to disassociate request from any Window. |

8
docs/development/core/public/kibana-plugin-core-public.httpresponse.md
View file

@ -15,8 +15,8 @@ export interface HttpResponse<TResponseBody = unknown>
| Property | Type | Description |
| --- | --- | --- |
| [body](./kibana-plugin-core-public.httpresponse.body.md) | <code>TResponseBody</code> | Parsed body received, may be undefined if there was an error. |
| [fetchOptions](./kibana-plugin-core-public.httpresponse.fetchoptions.md) | <code>Readonly&lt;HttpFetchOptionsWithPath&gt;</code> | The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request. |
| [request](./kibana-plugin-core-public.httpresponse.request.md) | <code>Readonly&lt;Request&gt;</code> | Raw request sent to Kibana server. |
| [response](./kibana-plugin-core-public.httpresponse.response.md) | <code>Readonly&lt;Response&gt;</code> | Raw response received, may be undefined if there was an error. |
| [body?](./kibana-plugin-core-public.httpresponse.body.md) | TResponseBody | <i>(Optional)</i> Parsed body received, may be undefined if there was an error. |
| [fetchOptions](./kibana-plugin-core-public.httpresponse.fetchoptions.md) | Readonly&lt;HttpFetchOptionsWithPath&gt; | The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request. |
| [request](./kibana-plugin-core-public.httpresponse.request.md) | Readonly&lt;Request&gt; | Raw request sent to Kibana server. |
| [response?](./kibana-plugin-core-public.httpresponse.response.md) | Readonly&lt;Response&gt; | <i>(Optional)</i> Raw response received, may be undefined if there was an error. |

4
docs/development/core/public/kibana-plugin-core-public.httpsetup.addloadingcountsource.md
View file

@ -16,9 +16,9 @@ addLoadingCountSource(countSource$: Observable<number>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| countSource$ | <code>Observable&lt;number&gt;</code> | |
| countSource$ | Observable&lt;number&gt; | an Observable to subscribe to for loading count updates. |
<b>Returns:</b>
`void`
void

2
docs/development/core/public/kibana-plugin-core-public.httpsetup.getloadingcount_.md
View file

@ -13,5 +13,5 @@ getLoadingCount$(): Observable<number>;
```
<b>Returns:</b>
`Observable<number>`
Observable&lt;number&gt;

4
docs/development/core/public/kibana-plugin-core-public.httpsetup.intercept.md
View file

@ -16,11 +16,11 @@ intercept(interceptor: HttpInterceptor): () => void;
| Parameter | Type | Description |
| --- | --- | --- |
| interceptor | <code>HttpInterceptor</code> | |
| interceptor | HttpInterceptor | a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) |
<b>Returns:</b>
`() => void`
() =&gt; void
a function for removing the attached interceptor.

22
docs/development/core/public/kibana-plugin-core-public.httpsetup.md
View file

@ -15,17 +15,17 @@ export interface HttpSetup
| Property | Type | Description |
| --- | --- | --- |
| [anonymousPaths](./kibana-plugin-core-public.httpsetup.anonymouspaths.md) | <code>IAnonymousPaths</code> | APIs for denoting certain paths for not requiring authentication |
| [basePath](./kibana-plugin-core-public.httpsetup.basepath.md) | <code>IBasePath</code> | APIs for manipulating the basePath on URL segments. See [IBasePath](./kibana-plugin-core-public.ibasepath.md) |
| [delete](./kibana-plugin-core-public.httpsetup.delete.md) | <code>HttpHandler</code> | Makes an HTTP request with the DELETE method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [externalUrl](./kibana-plugin-core-public.httpsetup.externalurl.md) | <code>IExternalUrl</code> | |
| [fetch](./kibana-plugin-core-public.httpsetup.fetch.md) | <code>HttpHandler</code> | Makes an HTTP request. Defaults to a GET request unless overridden. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [get](./kibana-plugin-core-public.httpsetup.get.md) | <code>HttpHandler</code> | Makes an HTTP request with the GET method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [head](./kibana-plugin-core-public.httpsetup.head.md) | <code>HttpHandler</code> | Makes an HTTP request with the HEAD method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [options](./kibana-plugin-core-public.httpsetup.options.md) | <code>HttpHandler</code> | Makes an HTTP request with the OPTIONS method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [patch](./kibana-plugin-core-public.httpsetup.patch.md) | <code>HttpHandler</code> | Makes an HTTP request with the PATCH method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [post](./kibana-plugin-core-public.httpsetup.post.md) | <code>HttpHandler</code> | Makes an HTTP request with the POST method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [put](./kibana-plugin-core-public.httpsetup.put.md) | <code>HttpHandler</code> | Makes an HTTP request with the PUT method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [anonymousPaths](./kibana-plugin-core-public.httpsetup.anonymouspaths.md) | IAnonymousPaths | APIs for denoting certain paths for not requiring authentication |
| [basePath](./kibana-plugin-core-public.httpsetup.basepath.md) | IBasePath | APIs for manipulating the basePath on URL segments. See [IBasePath](./kibana-plugin-core-public.ibasepath.md) |
| [delete](./kibana-plugin-core-public.httpsetup.delete.md) | HttpHandler | Makes an HTTP request with the DELETE method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [externalUrl](./kibana-plugin-core-public.httpsetup.externalurl.md) | IExternalUrl | |
| [fetch](./kibana-plugin-core-public.httpsetup.fetch.md) | HttpHandler | Makes an HTTP request. Defaults to a GET request unless overridden. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [get](./kibana-plugin-core-public.httpsetup.get.md) | HttpHandler | Makes an HTTP request with the GET method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [head](./kibana-plugin-core-public.httpsetup.head.md) | HttpHandler | Makes an HTTP request with the HEAD method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [options](./kibana-plugin-core-public.httpsetup.options.md) | HttpHandler | Makes an HTTP request with the OPTIONS method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [patch](./kibana-plugin-core-public.httpsetup.patch.md) | HttpHandler | Makes an HTTP request with the PATCH method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [post](./kibana-plugin-core-public.httpsetup.post.md) | HttpHandler | Makes an HTTP request with the POST method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
| [put](./kibana-plugin-core-public.httpsetup.put.md) | HttpHandler | Makes an HTTP request with the PUT method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. |
## Methods

2
docs/development/core/public/kibana-plugin-core-public.i18nstart.md
View file

@ -16,5 +16,5 @@ export interface I18nStart
| Property | Type | Description |
| --- | --- | --- |
| [Context](./kibana-plugin-core-public.i18nstart.context.md) | <code>({ children }: {</code><br/><code> children: React.ReactNode;</code><br/><code> }) =&gt; JSX.Element</code> | React Context provider required as the topmost component for any i18n-compatible React tree. |
| [Context](./kibana-plugin-core-public.i18nstart.context.md) | ({ children }: { children: React.ReactNode; }) =&gt; JSX.Element | React Context provider required as the topmost component for any i18n-compatible React tree. |

4
docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.isanonymous.md
View file

@ -16,9 +16,9 @@ isAnonymous(path: string): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| path | <code>string</code> | |
| path | string | |
<b>Returns:</b>
`boolean`
boolean

4
docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.register.md
View file

@ -16,9 +16,9 @@ register(path: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| path | <code>string</code> | |
| path | string | |
<b>Returns:</b>
`void`
void

10
docs/development/core/public/kibana-plugin-core-public.ibasepath.md
View file

@ -16,9 +16,9 @@ export interface IBasePath
| Property | Type | Description |
| --- | --- | --- |
| [get](./kibana-plugin-core-public.ibasepath.get.md) | <code>() =&gt; string</code> | Gets the <code>basePath</code> string. |
| [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) | <code>(url: string) =&gt; string</code> | Prepends <code>path</code> with the basePath. |
| [publicBaseUrl](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) | <code>string</code> | The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md)<!-- -->. |
| [remove](./kibana-plugin-core-public.ibasepath.remove.md) | <code>(url: string) =&gt; string</code> | Removes the prepended basePath from the <code>path</code>. |
| [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) | <code>string</code> | Returns the server's root basePath as configured, without any namespace prefix.<!-- -->See for getting the basePath value for a specific request |
| [get](./kibana-plugin-core-public.ibasepath.get.md) | () =&gt; string | Gets the <code>basePath</code> string. |
| [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) | (url: string) =&gt; string | Prepends <code>path</code> with the basePath. |
| [publicBaseUrl?](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) | string | <i>(Optional)</i> The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md)<!-- -->. |
| [remove](./kibana-plugin-core-public.ibasepath.remove.md) | (url: string) =&gt; string | Removes the prepended basePath from the <code>path</code>. |
| [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) | string | Returns the server's root basePath as configured, without any namespace prefix.<!-- -->See for getting the basePath value for a specific request |

4
docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md
View file

@ -18,9 +18,9 @@ validateUrl(relativeOrAbsoluteUrl: string): URL | null;
| Parameter | Type | Description |
| --- | --- | --- |
| relativeOrAbsoluteUrl | <code>string</code> | |
| relativeOrAbsoluteUrl | string | |
<b>Returns:</b>
`URL | null`
URL \| null

1
docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md
View file

@ -19,6 +19,5 @@ host?: string;
// allows access to all of google.com, using any protocol.
allow: true,
host: 'google.com'
```

6
docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md
View file

@ -16,7 +16,7 @@ export interface IExternalUrlPolicy
| Property | Type | Description |
| --- | --- | --- |
| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | <code>boolean</code> | Indicates if this policy allows or denies access to the described destination. |
| [host](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | <code>string</code> | Optional host describing the external destination. May be combined with <code>protocol</code>. |
| [protocol](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | <code>string</code> | Optional protocol describing the external destination. May be combined with <code>host</code>. |
| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | boolean | Indicates if this policy allows or denies access to the described destination. |
| [host?](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | string | <i>(Optional)</i> Optional host describing the external destination. May be combined with <code>protocol</code>. |
| [protocol?](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | string | <i>(Optional)</i> Optional protocol describing the external destination. May be combined with <code>host</code>. |

1
docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md
View file

@ -19,6 +19,5 @@ protocol?: string;
// allows access to all destinations over the `https` protocol.
allow: true,
protocol: 'https'
```

13
docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md
View file

@ -10,15 +10,16 @@
```typescript
export interface IHttpFetchError<TResponseBody = unknown> extends Error
```
<b>Extends:</b> Error
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [body](./kibana-plugin-core-public.ihttpfetcherror.body.md) | <code>TResponseBody</code> | |
| [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) | <code>string</code> | |
| [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) | <code>Request</code> | |
| [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) | <code>Request</code> | |
| [res](./kibana-plugin-core-public.ihttpfetcherror.res.md) | <code>Response</code> | |
| [response](./kibana-plugin-core-public.ihttpfetcherror.response.md) | <code>Response</code> | |
| [body?](./kibana-plugin-core-public.ihttpfetcherror.body.md) | TResponseBody | <i>(Optional)</i> |
| [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) | string | |
| [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) | Request | |
| [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) | Request | |
| [res?](./kibana-plugin-core-public.ihttpfetcherror.res.md) | Response | <i>(Optional)</i> |
| [response?](./kibana-plugin-core-public.ihttpfetcherror.response.md) | Response | <i>(Optional)</i> |

2
docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md
View file

@ -13,5 +13,5 @@ halt(): void;
```
<b>Returns:</b>
`void`
void

2
docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md
View file

@ -16,7 +16,7 @@ export interface IHttpInterceptController
| Property | Type | Description |
| --- | --- | --- |
| [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) | <code>boolean</code> | Whether or not this chain has been halted. |
| [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) | boolean | Whether or not this chain has been halted. |
## Methods

Some files were not shown because too many files have changed in this diff Show more