Make generated type docs more explorable

elastic · Oct 7, 2019 · cc9e8f7 · cc9e8f7
1 parent c30a2f9
commit cc9e8f7
Show file tree

Hide file tree

Showing 134 changed files with 1,377 additions and 1,065 deletions.
diff --git a/docs/development/core/public/kibana-plugin-public.httperrorresponse.error.md b/docs/development/core/public/kibana-plugin-public.httperrorresponse.error.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-error: Error | HttpFetchError;
+error: Error | IHttpFetchError;
 ```
diff --git a/docs/development/core/public/kibana-plugin-public.httperrorresponse.md b/docs/development/core/public/kibana-plugin-public.httperrorresponse.md
@@ -16,7 +16,7 @@ export interface HttpErrorResponse
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [body](./kibana-plugin-public.httperrorresponse.body.md) | <code>HttpBody</code> |  |
-|  [error](./kibana-plugin-public.httperrorresponse.error.md) | <code>Error &#124; HttpFetchError</code> |  |
+|  [error](./kibana-plugin-public.httperrorresponse.error.md) | <code>Error &#124; IHttpFetchError</code> |  |
 |  [request](./kibana-plugin-public.httperrorresponse.request.md) | <code>Request</code> |  |
 |  [response](./kibana-plugin-public.httperrorresponse.response.md) | <code>Response</code> |  |
 
diff --git a/docs/development/core/public/kibana-plugin-public.httpfetchoptions.headers.md b/docs/development/core/public/kibana-plugin-public.httpfetchoptions.headers.md
@@ -4,6 +4,8 @@
 
 ## HttpFetchOptions.headers property
 
+Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md)<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httpfetchoptions.md b/docs/development/core/public/kibana-plugin-public.httpfetchoptions.md
@@ -4,6 +4,7 @@
 
 ## HttpFetchOptions interface
 
+All options that may be used with a [HttpHandler](./kibana-plugin-public.httphandler.md)<!-- -->.
 
 <b>Signature:</b>
 
@@ -15,7 +16,7 @@ export interface HttpFetchOptions extends HttpRequestInit
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [headers](./kibana-plugin-public.httpfetchoptions.headers.md) | <code>HttpHeadersInit</code> |  |
-|  [prependBasePath](./kibana-plugin-public.httpfetchoptions.prependbasepath.md) | <code>boolean</code> |  |
-|  [query](./kibana-plugin-public.httpfetchoptions.query.md) | <code>HttpFetchQuery</code> |  |
+|  [headers](./kibana-plugin-public.httpfetchoptions.headers.md) | <code>HttpHeadersInit</code> | Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md)<!-- -->. |
+|  [prependBasePath](./kibana-plugin-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-public.httpfetchoptions.query.md) | <code>HttpFetchQuery</code> | The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-public.httpfetchquery.md)<!-- -->. |
 
diff --git a/...evelopment/core/public/kibana-plugin-public.httpfetchoptions.prependbasepath.md b/...evelopment/core/public/kibana-plugin-public.httpfetchoptions.prependbasepath.md
@@ -4,6 +4,8 @@
 
 ## HttpFetchOptions.prependBasePath property
 
+Whether or not the request should automatically prepend the basePath. Defaults to `true`<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httpfetchoptions.query.md b/docs/development/core/public/kibana-plugin-public.httpfetchoptions.query.md
@@ -4,6 +4,8 @@
 
 ## HttpFetchOptions.query property
 
+The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-public.httpfetchquery.md)<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httphandler.md b/docs/development/core/public/kibana-plugin-public.httphandler.md
@@ -4,6 +4,7 @@
 
 ## HttpHandler type
 
+A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [HttpBody](./kibana-plugin-public.httpbody.md) for the response.
 
 <b>Signature:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.httpinterceptcontroller.halt.md b/docs/development/core/public/kibana-plugin-public.httpinterceptcontroller.halt.md
diff --git a/.../development/core/public/kibana-plugin-public.httpinterceptcontroller.halted.md b/.../development/core/public/kibana-plugin-public.httpinterceptcontroller.halted.md
diff --git a/docs/development/core/public/kibana-plugin-public.httpinterceptcontroller.md b/docs/development/core/public/kibana-plugin-public.httpinterceptcontroller.md
diff --git a/docs/development/core/public/kibana-plugin-public.httpinterceptor.md b/docs/development/core/public/kibana-plugin-public.httpinterceptor.md
@@ -4,6 +4,7 @@
 
 ## HttpInterceptor interface
 
+An object that may define global interceptor functions for different parts of the request and response lifecycle. See [IHttpInterceptController](./kibana-plugin-public.ihttpinterceptcontroller.md)<!-- -->.
 
 <b>Signature:</b>
 
@@ -15,8 +16,8 @@ export interface HttpInterceptor
 
 |  Method | Description |
 |  --- | --- |
-|  [request(request, controller)](./kibana-plugin-public.httpinterceptor.request.md) |  |
-|  [requestError(httpErrorRequest, controller)](./kibana-plugin-public.httpinterceptor.requesterror.md) |  |
-|  [response(httpResponse, controller)](./kibana-plugin-public.httpinterceptor.response.md) |  |
-|  [responseError(httpErrorResponse, controller)](./kibana-plugin-public.httpinterceptor.responseerror.md) |  |
+|  [request(request, controller)](./kibana-plugin-public.httpinterceptor.request.md) | Define an interceptor to be executed before a request is sent. |
+|  [requestError(httpErrorRequest, controller)](./kibana-plugin-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-public.httpinterceptor.response.md) | Define an interceptor to be executed after a response is received. |
+|  [responseError(httpErrorResponse, controller)](./kibana-plugin-public.httpinterceptor.responseerror.md) | Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. |
 
diff --git a/docs/development/core/public/kibana-plugin-public.httpinterceptor.request.md b/docs/development/core/public/kibana-plugin-public.httpinterceptor.request.md
@@ -4,18 +4,20 @@
 
 ## HttpInterceptor.request() method
 
+Define an interceptor to be executed before a request is sent.
+
 <b>Signature:</b>
 
 ```typescript
-request?(request: Request, controller: HttpInterceptController): Promise<Request> | Request | void;
+request?(request: Request, controller: IHttpInterceptController): Promise<Request> | Request | void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  request | <code>Request</code> |  |
-|  controller | <code>HttpInterceptController</code> |  |
+|  controller | <code>IHttpInterceptController</code> |  |
 
 <b>Returns:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.httpinterceptor.requesterror.md b/docs/development/core/public/kibana-plugin-public.httpinterceptor.requesterror.md
@@ -4,18 +4,20 @@
 
 ## HttpInterceptor.requestError() method
 
+Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise.
+
 <b>Signature:</b>
 
 ```typescript
-requestError?(httpErrorRequest: HttpErrorRequest, controller: HttpInterceptController): Promise<Request> | Request | void;
+requestError?(httpErrorRequest: HttpErrorRequest, controller: IHttpInterceptController): Promise<Request> | Request | void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  httpErrorRequest | <code>HttpErrorRequest</code> |  |
-|  controller | <code>HttpInterceptController</code> |  |
+|  controller | <code>IHttpInterceptController</code> |  |
 
 <b>Returns:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.httpinterceptor.response.md b/docs/development/core/public/kibana-plugin-public.httpinterceptor.response.md
@@ -4,18 +4,20 @@
 
 ## HttpInterceptor.response() method
 
+Define an interceptor to be executed after a response is received.
+
 <b>Signature:</b>
 
 ```typescript
-response?(httpResponse: HttpResponse, controller: HttpInterceptController): Promise<HttpResponse> | HttpResponse | void;
+response?(httpResponse: HttpResponse, controller: IHttpInterceptController): Promise<HttpResponse> | HttpResponse | void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  httpResponse | <code>HttpResponse</code> |  |
-|  controller | <code>HttpInterceptController</code> |  |
+|  controller | <code>IHttpInterceptController</code> |  |
 
 <b>Returns:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.httpinterceptor.responseerror.md b/docs/development/core/public/kibana-plugin-public.httpinterceptor.responseerror.md
@@ -4,18 +4,20 @@
 
 ## HttpInterceptor.responseError() method
 
+Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise.
+
 <b>Signature:</b>
 
 ```typescript
-responseError?(httpErrorResponse: HttpErrorResponse, controller: HttpInterceptController): Promise<HttpResponse> | HttpResponse | void;
+responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptController): Promise<HttpResponse> | HttpResponse | void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  httpErrorResponse | <code>HttpErrorResponse</code> |  |
-|  controller | <code>HttpInterceptController</code> |  |
+|  controller | <code>IHttpInterceptController</code> |  |
 
 <b>Returns:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.body.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.body.md
@@ -4,6 +4,7 @@
 
 ## HttpRequestInit.body property
 
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.cache.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.cache.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.cache property
 
+The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.credentials.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.credentials.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.credentials property
 
+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.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.headers.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.headers.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.headers property
 
+[HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md)
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.integrity.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.integrity.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.integrity property
 
+Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.keepalive.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.keepalive.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.keepalive property
 
+Whether or not request can outlive the global in which it was created.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.md
@@ -4,6 +4,7 @@
 
 ## HttpRequestInit interface
 
+Fetch API options available to [HttpHandler](./kibana-plugin-public.httphandler.md)<!-- -->s.
 
 <b>Signature:</b>
 
@@ -16,16 +17,16 @@ export interface HttpRequestInit
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [body](./kibana-plugin-public.httprequestinit.body.md) | <code>BodyInit &#124; null</code> |  |
-|  [cache](./kibana-plugin-public.httprequestinit.cache.md) | <code>RequestCache</code> |  |
-|  [credentials](./kibana-plugin-public.httprequestinit.credentials.md) | <code>RequestCredentials</code> |  |
-|  [headers](./kibana-plugin-public.httprequestinit.headers.md) | <code>HttpHeadersInit</code> |  |
-|  [integrity](./kibana-plugin-public.httprequestinit.integrity.md) | <code>string</code> |  |
-|  [keepalive](./kibana-plugin-public.httprequestinit.keepalive.md) | <code>boolean</code> |  |
-|  [method](./kibana-plugin-public.httprequestinit.method.md) | <code>string</code> |  |
-|  [mode](./kibana-plugin-public.httprequestinit.mode.md) | <code>RequestMode</code> |  |
-|  [redirect](./kibana-plugin-public.httprequestinit.redirect.md) | <code>RequestRedirect</code> |  |
-|  [referrer](./kibana-plugin-public.httprequestinit.referrer.md) | <code>string</code> |  |
-|  [referrerPolicy](./kibana-plugin-public.httprequestinit.referrerpolicy.md) | <code>ReferrerPolicy</code> |  |
-|  [signal](./kibana-plugin-public.httprequestinit.signal.md) | <code>AbortSignal &#124; null</code> |  |
-|  [window](./kibana-plugin-public.httprequestinit.window.md) | <code>any</code> |  |
+|  [cache](./kibana-plugin-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-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-public.httprequestinit.headers.md) | <code>HttpHeadersInit</code> | [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md) |
+|  [integrity](./kibana-plugin-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-public.httprequestinit.keepalive.md) | <code>boolean</code> | Whether or not request can outlive the global in which it was created. |
+|  [method](./kibana-plugin-public.httprequestinit.method.md) | <code>string</code> | HTTP method, which is "GET" by default. |
+|  [mode](./kibana-plugin-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-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-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-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-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-public.httprequestinit.window.md) | <code>null</code> | Can only be null. Used to disassociate request from any Window. |
 
diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.method.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.method.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.method property
 
+HTTP method, which is "GET" by default.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.mode.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.mode.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.mode property
 
+The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.redirect.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.redirect.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.redirect property
 
+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.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.referrer.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.referrer.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.referrer property
 
+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 `Referer` header of the request being made.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/.../development/core/public/kibana-plugin-public.httprequestinit.referrerpolicy.md b/.../development/core/public/kibana-plugin-public.httprequestinit.referrerpolicy.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.referrerPolicy property
 
+The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.signal.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.signal.md
@@ -4,6 +4,8 @@
 
 ## HttpRequestInit.signal property
 
+Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/development/core/public/kibana-plugin-public.httprequestinit.window.md b/docs/development/core/public/kibana-plugin-public.httprequestinit.window.md
@@ -4,8 +4,10 @@
 
 ## HttpRequestInit.window property
 
+Can only be null. Used to disassociate request from any Window.
+
 <b>Signature:</b>
 
 ```typescript
-window?: any;
+window?: null;
 ```