Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mshustov committed Jun 16, 2019
1 parent 4788eb9 commit 52bfa2d
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ export interface HttpServiceSetup extends HttpServerSetup
| Property | Type | Description |
| --- | --- | --- |
| [createNewServer](./kibana-plugin-server.httpservicesetup.createnewserver.md) | <code>(cfg: Partial&lt;HttpConfig&gt;) =&gt; Promise&lt;HttpServerSetup&gt;</code> | |
| [shouldListen](./kibana-plugin-server.httpservicesetup.shouldlisten.md) | <code>() =&gt; boolean</code> | Indicates if http server has configured to start listening on a configured port |
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) &gt; [shouldListen](./kibana-plugin-server.httpservicesetup.shouldlisten.md)

## HttpServiceSetup.shouldListen property

Indicates if http server has configured to start listening on a configured port

<b>Signature:</b>

```typescript
shouldListen: () => boolean;
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

## HttpServiceStart.isListening property

Indicates if http server is listening on a port
Indicates if http server is listening on a given port

<b>Signature:</b>

```typescript
isListening: () => boolean;
isListening: (port: number) => boolean;
```
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ export interface HttpServiceStart

| Property | Type | Description |
| --- | --- | --- |
| [isListening](./kibana-plugin-server.httpservicestart.islistening.md) | <code>() =&gt; boolean</code> | Indicates if http server is listening on a port |
| [isListening](./kibana-plugin-server.httpservicestart.islistening.md) | <code>(port: number) =&gt; boolean</code> | Indicates if http server is listening on a given port |

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@ export interface InternalCoreStart

| Property | Type | Description |
| --- | --- | --- |
| [http](./kibana-plugin-server.internalcorestart.http.md) | <code>HttpServiceStart</code> | |
| [plugins](./kibana-plugin-server.internalcorestart.plugins.md) | <code>PluginsServiceStart</code> | |

5 changes: 2 additions & 3 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,12 @@ export interface HttpServiceSetup extends HttpServerSetup {
//
// (undocumented)
createNewServer: (cfg: Partial<HttpConfig>) => Promise<HttpServerSetup>;
shouldListen: () => boolean;
}

// @public (undocumented)
export interface HttpServiceStart {
isListening: () => boolean;
isListening: (port: number) => boolean;
}

// @internal (undocumented)
Expand All @@ -159,8 +160,6 @@ export interface InternalCoreSetup {

// @public (undocumented)
export interface InternalCoreStart {
// (undocumented)
http: HttpServiceStart;
// (undocumented)
plugins: PluginsServiceStart;
}
Expand Down

0 comments on commit 52bfa2d

Please sign in to comment.