Skip to content

Commit a48c47f

Browse files
committed
update docs
1 parent 98a5e5c commit a48c47f

11 files changed

+65
-4
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [KibanaRequest](./kibana-plugin-server.kibanarequest.md) &gt; [events](./kibana-plugin-server.kibanarequest.events.md)
4+
5+
## KibanaRequest.events property
6+
7+
Request events [KibanaRequestEvents](./kibana-plugin-server.kibanarequestevents.md)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
readonly events: KibanaRequestEvents;
13+
```

docs/development/core/server/kibana-plugin-server.kibanarequest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ export declare class KibanaRequest<Params = unknown, Query = unknown, Body = unk
2323
| Property | Modifiers | Type | Description |
2424
| --- | --- | --- | --- |
2525
| [body](./kibana-plugin-server.kibanarequest.body.md) | | <code>Body</code> | |
26+
| [events](./kibana-plugin-server.kibanarequest.events.md) | | <code>KibanaRequestEvents</code> | Request events [KibanaRequestEvents](./kibana-plugin-server.kibanarequestevents.md) |
2627
| [headers](./kibana-plugin-server.kibanarequest.headers.md) | | <code>Headers</code> | Readonly copy of incoming request headers. |
2728
| [params](./kibana-plugin-server.kibanarequest.params.md) | | <code>Params</code> | |
2829
| [query](./kibana-plugin-server.kibanarequest.query.md) | | <code>Query</code> | |
2930
| [route](./kibana-plugin-server.kibanarequest.route.md) | | <code>RecursiveReadonly&lt;KibanaRequestRoute&lt;Method&gt;&gt;</code> | matched route details |
30-
| [socket](./kibana-plugin-server.kibanarequest.socket.md) | | <code>IKibanaSocket</code> | |
31+
| [socket](./kibana-plugin-server.kibanarequest.socket.md) | | <code>IKibanaSocket</code> | [IKibanaSocket](./kibana-plugin-server.ikibanasocket.md) |
3132
| [url](./kibana-plugin-server.kibanarequest.url.md) | | <code>Url</code> | a WHATWG URL standard object. |
3233

docs/development/core/server/kibana-plugin-server.kibanarequest.socket.md

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

55
## KibanaRequest.socket property
66

7+
[IKibanaSocket](./kibana-plugin-server.ikibanasocket.md)
8+
79
<b>Signature:</b>
810

911
```typescript
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [KibanaRequestEvents](./kibana-plugin-server.kibanarequestevents.md) &gt; [aborted$](./kibana-plugin-server.kibanarequestevents.aborted_.md)
4+
5+
## KibanaRequestEvents.aborted$ property
6+
7+
emits once when the request has been aborted.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
aborted$: Observable<void>;
13+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [KibanaRequestEvents](./kibana-plugin-server.kibanarequestevents.md)
4+
5+
## KibanaRequestEvents interface
6+
7+
Request events.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface KibanaRequestEvents
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [aborted$](./kibana-plugin-server.kibanarequestevents.aborted_.md) | <code>Observable&lt;void&gt;</code> | emits once when the request has been aborted. |
20+

docs/development/core/server/kibana-plugin-server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
7474
| [IRouter](./kibana-plugin-server.irouter.md) | Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-server.routeconfig.md) and [RequestHandler](./kibana-plugin-server.requesthandler.md) for more information about arguments to route registrations. |
7575
| [IScopedRenderingClient](./kibana-plugin-server.iscopedrenderingclient.md) | |
7676
| [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) | Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. |
77+
| [KibanaRequestEvents](./kibana-plugin-server.kibanarequestevents.md) | Request events. |
7778
| [KibanaRequestRoute](./kibana-plugin-server.kibanarequestroute.md) | Request specific route information exposed to a handler. |
7879
| [LegacyRequest](./kibana-plugin-server.legacyrequest.md) | |
7980
| [LegacyServiceSetupDeps](./kibana-plugin-server.legacyservicesetupdeps.md) | |

src/core/server/http/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ export {
2929
HttpResponsePayload,
3030
ErrorHttpResponseOptions,
3131
KibanaRequest,
32+
KibanaRequestEvents,
3233
KibanaRequestRoute,
3334
KibanaRequestRouteOptions,
3435
IKibanaResponse,

src/core/server/http/router/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export { Headers, filterHeaders, ResponseHeaders, KnownHeaders } from './headers
2121
export { Router, RequestHandler, IRouter, RouteRegistrar } from './router';
2222
export {
2323
KibanaRequest,
24+
KibanaRequestEvents,
2425
KibanaRequestRoute,
2526
KibanaRequestRouteOptions,
2627
isRealRequest,

src/core/server/http/router/request.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ export interface KibanaRequestRoute<Method extends RouteMethod> {
4949
}
5050

5151
/**
52-
* KibanaRequest events
52+
* Request events.
5353
* @public
54-
*/
54+
* */
5555
export interface KibanaRequestEvents {
5656
/**
57-
* emits once & completes when the request has been aborted.
57+
* emits once when the request has been aborted.
5858
*/
5959
aborted$: Observable<void>;
6060
}
@@ -128,7 +128,9 @@ export class KibanaRequest<
128128
*/
129129
public readonly headers: Headers;
130130

131+
/** {@link IKibanaSocket} */
131132
public readonly socket: IKibanaSocket;
133+
/** Request events {@link KibanaRequestEvents} */
132134
public readonly events: KibanaRequestEvents;
133135

134136
/** @internal */

src/core/server/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ export {
109109
IKibanaSocket,
110110
IsAuthenticated,
111111
KibanaRequest,
112+
KibanaRequestEvents,
112113
KibanaRequestRoute,
113114
KibanaRequestRouteOptions,
114115
IKibanaResponse,

0 commit comments

Comments
 (0)