-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
265 additions
and
382 deletions.
There are no files selected for viewing
36 changes: 18 additions & 18 deletions
36
...ment/core/server/kibana-plugin-server.httpservicesetup.registeronpreresponse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) > [registerOnPreResponse](./kibana-plugin-server.httpservicesetup.registeronpreresponse.md) | ||
|
||
## HttpServiceSetup.registerOnPreResponse property | ||
|
||
To define custom logic to perform for the server response. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
registerOnPreResponse: (handler: OnPreResponseHandler) => void; | ||
``` | ||
|
||
## Remarks | ||
|
||
Doesn't provide the whole response object. Supports extending response with custom headers. See [OnPreResponseHandler](./kibana-plugin-server.onpreresponsehandler.md)<!-- -->. | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) > [registerOnPreResponse](./kibana-plugin-server.httpservicesetup.registeronpreresponse.md) | ||
|
||
## HttpServiceSetup.registerOnPreResponse property | ||
|
||
To define custom logic to perform for the server response. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
registerOnPreResponse: (handler: OnPreResponseHandler) => void; | ||
``` | ||
|
||
## Remarks | ||
|
||
Doesn't provide the whole response object. Supports extending response with custom headers. See [OnPreResponseHandler](./kibana-plugin-server.onpreresponsehandler.md)<!-- -->. | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
26 changes: 13 additions & 13 deletions
26
docs/development/core/server/kibana-plugin-server.onpreresponsehandler.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnPreResponseHandler](./kibana-plugin-server.onpreresponsehandler.md) | ||
|
||
## OnPreResponseHandler type | ||
|
||
See [OnPreAuthToolkit](./kibana-plugin-server.onpreauthtoolkit.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type OnPreResponseHandler = (request: KibanaRequest, preResponse: OnPreResponseInfo, toolkit: OnPreResponseToolkit) => OnPreResponseResult | Promise<OnPreResponseResult>; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnPreResponseHandler](./kibana-plugin-server.onpreresponsehandler.md) | ||
|
||
## OnPreResponseHandler type | ||
|
||
See [OnPreAuthToolkit](./kibana-plugin-server.onpreauthtoolkit.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type OnPreResponseHandler = (request: KibanaRequest, preResponse: OnPreResponseInfo, toolkit: OnPreResponseToolkit) => OnPreResponseResult | Promise<OnPreResponseResult>; | ||
``` |
40 changes: 20 additions & 20 deletions
40
docs/development/core/server/kibana-plugin-server.onpreresponsetoolkit.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnPreResponseToolkit](./kibana-plugin-server.onpreresponsetoolkit.md) | ||
|
||
## OnPreResponseToolkit interface | ||
|
||
A tool set defining an outcome of OnPreAuth interceptor for incoming request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface OnPreResponseToolkit | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [next](./kibana-plugin-server.onpreresponsetoolkit.next.md) | <code>(responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult</code> | To pass request to the next handler | | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnPreResponseToolkit](./kibana-plugin-server.onpreresponsetoolkit.md) | ||
|
||
## OnPreResponseToolkit interface | ||
|
||
A tool set defining an outcome of OnPreAuth interceptor for incoming request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface OnPreResponseToolkit | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [next](./kibana-plugin-server.onpreresponsetoolkit.next.md) | <code>(responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult</code> | To pass request to the next handler | | ||
|
26 changes: 13 additions & 13 deletions
26
docs/development/core/server/kibana-plugin-server.onpreresponsetoolkit.next.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnPreResponseToolkit](./kibana-plugin-server.onpreresponsetoolkit.md) > [next](./kibana-plugin-server.onpreresponsetoolkit.next.md) | ||
|
||
## OnPreResponseToolkit.next property | ||
|
||
To pass request to the next handler | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
next: (responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnPreResponseToolkit](./kibana-plugin-server.onpreresponsetoolkit.md) > [next](./kibana-plugin-server.onpreresponsetoolkit.next.md) | ||
|
||
## OnPreResponseToolkit.next property | ||
|
||
To pass request to the next handler | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
next: (responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult; | ||
``` |
11 changes: 0 additions & 11 deletions
11
docs/development/core/server/kibana-plugin-server.responseextensions.headers.md
This file was deleted.
Oops, something went wrong.
20 changes: 0 additions & 20 deletions
20
docs/development/core/server/kibana-plugin-server.responseextensions.md
This file was deleted.
Oops, something went wrong.
20 changes: 0 additions & 20 deletions
20
docs/development/core/server/kibana-plugin-server.responseinfo.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
docs/development/core/server/kibana-plugin-server.responseinfo.statuscode.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters