Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into np/linkable-types
Browse files Browse the repository at this point in the history
  • Loading branch information
joshdover committed Oct 15, 2019
2 parents fcbc658 + 3454c00 commit 5a53f7f
Show file tree
Hide file tree
Showing 521 changed files with 11,716 additions and 7,965 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ module.exports = {
'src/core/server/**/*',
'!src/core/server/index.ts',
'!src/core/server/mocks.ts',
'!src/core/server/types.ts',
'!src/core/server/*.test.mocks.ts',

'src/plugins/**/public/**/*',
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md) &gt; [dev](./kibana-plugin-public.environmentmode.dev.md)

## EnvironmentMode.dev property

<b>Signature:</b>

```typescript
dev: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md)

## EnvironmentMode interface


<b>Signature:</b>

```typescript
export interface EnvironmentMode
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [dev](./kibana-plugin-public.environmentmode.dev.md) | <code>boolean</code> | |
| [name](./kibana-plugin-public.environmentmode.name.md) | <code>'development' &#124; 'production'</code> | |
| [prod](./kibana-plugin-public.environmentmode.prod.md) | <code>boolean</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md) &gt; [name](./kibana-plugin-public.environmentmode.name.md)

## EnvironmentMode.name property

<b>Signature:</b>

```typescript
name: 'development' | 'production';
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md) &gt; [prod](./kibana-plugin-public.environmentmode.prod.md)

## EnvironmentMode.prod property

<b>Signature:</b>

```typescript
prod: boolean;
```
2 changes: 2 additions & 0 deletions docs/development/core/public/kibana-plugin-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the <code>Plugin</code> setup lifecycle |
| [CoreStart](./kibana-plugin-public.corestart.md) | Core services exposed to the <code>Plugin</code> start lifecycle |
| [DocLinksStart](./kibana-plugin-public.doclinksstart.md) | |
| [EnvironmentMode](./kibana-plugin-public.environmentmode.md) | |
| [ErrorToastOptions](./kibana-plugin-public.errortoastoptions.md) | Options available for [IToasts](./kibana-plugin-public.itoasts.md) APIs. |
| [FatalErrorInfo](./kibana-plugin-public.fatalerrorinfo.md) | Represents the <code>message</code> and <code>stack</code> of a fatal Error |
| [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
Expand All @@ -69,6 +70,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) | |
| [OverlayRef](./kibana-plugin-public.overlayref.md) | Returned by [OverlayStart](./kibana-plugin-public.overlaystart.md) methods for closing a mounted overlay. |
| [OverlayStart](./kibana-plugin-public.overlaystart.md) | |
| [PackageInfo](./kibana-plugin-public.packageinfo.md) | |
| [Plugin](./kibana-plugin-public.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
| [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md) | The available core services passed to a <code>PluginInitializer</code> |
| [SavedObject](./kibana-plugin-public.savedobject.md) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [branch](./kibana-plugin-public.packageinfo.branch.md)

## PackageInfo.branch property

<b>Signature:</b>

```typescript
branch: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [buildNum](./kibana-plugin-public.packageinfo.buildnum.md)

## PackageInfo.buildNum property

<b>Signature:</b>

```typescript
buildNum: number;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [buildSha](./kibana-plugin-public.packageinfo.buildsha.md)

## PackageInfo.buildSha property

<b>Signature:</b>

```typescript
buildSha: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [dist](./kibana-plugin-public.packageinfo.dist.md)

## PackageInfo.dist property

<b>Signature:</b>

```typescript
dist: boolean;
```
23 changes: 23 additions & 0 deletions docs/development/core/public/kibana-plugin-public.packageinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md)

## PackageInfo interface


<b>Signature:</b>

```typescript
export interface PackageInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [branch](./kibana-plugin-public.packageinfo.branch.md) | <code>string</code> | |
| [buildNum](./kibana-plugin-public.packageinfo.buildnum.md) | <code>number</code> | |
| [buildSha](./kibana-plugin-public.packageinfo.buildsha.md) | <code>string</code> | |
| [dist](./kibana-plugin-public.packageinfo.dist.md) | <code>boolean</code> | |
| [version](./kibana-plugin-public.packageinfo.version.md) | <code>string</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [version](./kibana-plugin-public.packageinfo.version.md)

## PackageInfo.version property

<b>Signature:</b>

```typescript
version: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md) &gt; [env](./kibana-plugin-public.plugininitializercontext.env.md)

## PluginInitializerContext.env property

<b>Signature:</b>

```typescript
readonly env: {
mode: Readonly<EnvironmentMode>;
packageInfo: Readonly<PackageInfo>;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ export interface PluginInitializerContext

| Property | Type | Description |
| --- | --- | --- |
| [env](./kibana-plugin-public.plugininitializercontext.env.md) | <code>{</code><br/><code> mode: Readonly&lt;EnvironmentMode&gt;;</code><br/><code> packageInfo: Readonly&lt;PackageInfo&gt;;</code><br/><code> }</code> | |
| [opaqueId](./kibana-plugin-public.plugininitializercontext.opaqueid.md) | <code>PluginOpaqueId</code> | A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. |

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## ToastsApi.get$() method

Current array of toast messages to show to user.
Observable of the toast messages to show to the user.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ export declare class ToastsApi implements IToasts
| [addError(error, options)](./kibana-plugin-public.toastsapi.adderror.md) | | Adds a new toast that displays an exception message with a button to open the full stacktrace in a modal. |
| [addSuccess(toastOrTitle)](./kibana-plugin-public.toastsapi.addsuccess.md) | | Adds a new toast pre-configured with the success color and check icon. |
| [addWarning(toastOrTitle)](./kibana-plugin-public.toastsapi.addwarning.md) | | Adds a new toast pre-configured with the warning color and help icon. |
| [get$()](./kibana-plugin-public.toastsapi.get_.md) | | Current array of toast messages to show to user. |
| [get$()](./kibana-plugin-public.toastsapi.get_.md) | | Observable of the toast messages to show to the user. |
| [remove(toast)](./kibana-plugin-public.toastsapi.remove.md) | | Removes a toast from the current array of toasts if present. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md) &gt; [dev](./kibana-plugin-server.environmentmode.dev.md)

## EnvironmentMode.dev property

<b>Signature:</b>

```typescript
dev: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md)

## EnvironmentMode interface


<b>Signature:</b>

```typescript
export interface EnvironmentMode
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [dev](./kibana-plugin-server.environmentmode.dev.md) | <code>boolean</code> | |
| [name](./kibana-plugin-server.environmentmode.name.md) | <code>'development' &#124; 'production'</code> | |
| [prod](./kibana-plugin-server.environmentmode.prod.md) | <code>boolean</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md) &gt; [name](./kibana-plugin-server.environmentmode.name.md)

## EnvironmentMode.name property

<b>Signature:</b>

```typescript
name: 'development' | 'production';
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md) &gt; [prod](./kibana-plugin-server.environmentmode.prod.md)

## EnvironmentMode.prod property

<b>Signature:</b>

```typescript
prod: boolean;
```
2 changes: 2 additions & 0 deletions docs/development/core/server/kibana-plugin-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [DiscoveredPlugin](./kibana-plugin-server.discoveredplugin.md) | Small container object used to expose information about discovered plugins that may or may not have been started. |
| [ElasticsearchError](./kibana-plugin-server.elasticsearcherror.md) | |
| [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) | |
| [EnvironmentMode](./kibana-plugin-server.environmentmode.md) | |
| [ErrorHttpResponseOptions](./kibana-plugin-server.errorhttpresponseoptions.md) | HTTP response parameters |
| [FakeRequest](./kibana-plugin-server.fakerequest.md) | Fake request object created manually by Kibana plugins. |
| [HttpResponseOptions](./kibana-plugin-server.httpresponseoptions.md) | HTTP response parameters |
Expand All @@ -70,6 +71,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [LogMeta](./kibana-plugin-server.logmeta.md) | Contextual metadata |
| [OnPostAuthToolkit](./kibana-plugin-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. |
| [OnPreAuthToolkit](./kibana-plugin-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |
| [PackageInfo](./kibana-plugin-server.packageinfo.md) | |
| [Plugin](./kibana-plugin-server.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
| [PluginInitializerContext](./kibana-plugin-server.plugininitializercontext.md) | Context that's available to plugins during initialization stage. |
| [PluginManifest](./kibana-plugin-server.pluginmanifest.md) | Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [branch](./kibana-plugin-server.packageinfo.branch.md)

## PackageInfo.branch property

<b>Signature:</b>

```typescript
branch: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [buildNum](./kibana-plugin-server.packageinfo.buildnum.md)

## PackageInfo.buildNum property

<b>Signature:</b>

```typescript
buildNum: number;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [buildSha](./kibana-plugin-server.packageinfo.buildsha.md)

## PackageInfo.buildSha property

<b>Signature:</b>

```typescript
buildSha: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [dist](./kibana-plugin-server.packageinfo.dist.md)

## PackageInfo.dist property

<b>Signature:</b>

```typescript
dist: boolean;
```
23 changes: 23 additions & 0 deletions docs/development/core/server/kibana-plugin-server.packageinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md)

## PackageInfo interface


<b>Signature:</b>

```typescript
export interface PackageInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [branch](./kibana-plugin-server.packageinfo.branch.md) | <code>string</code> | |
| [buildNum](./kibana-plugin-server.packageinfo.buildnum.md) | <code>number</code> | |
| [buildSha](./kibana-plugin-server.packageinfo.buildsha.md) | <code>string</code> | |
| [dist](./kibana-plugin-server.packageinfo.dist.md) | <code>boolean</code> | |
| [version](./kibana-plugin-server.packageinfo.version.md) | <code>string</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [version](./kibana-plugin-server.packageinfo.version.md)

## PackageInfo.version property

<b>Signature:</b>

```typescript
version: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@
```typescript
env: {
mode: EnvironmentMode;
packageInfo: Readonly<PackageInfo>;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface PluginInitializerContext<ConfigSchema = unknown>
| Property | Type | Description |
| --- | --- | --- |
| [config](./kibana-plugin-server.plugininitializercontext.config.md) | <code>{</code><br/><code> create: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T&gt;;</code><br/><code> createIfExists: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T &#124; undefined&gt;;</code><br/><code> }</code> | |
| [env](./kibana-plugin-server.plugininitializercontext.env.md) | <code>{</code><br/><code> mode: EnvironmentMode;</code><br/><code> }</code> | |
| [env](./kibana-plugin-server.plugininitializercontext.env.md) | <code>{</code><br/><code> mode: EnvironmentMode;</code><br/><code> packageInfo: Readonly&lt;PackageInfo&gt;;</code><br/><code> }</code> | |
| [logger](./kibana-plugin-server.plugininitializercontext.logger.md) | <code>LoggerFactory</code> | |
| [opaqueId](./kibana-plugin-server.plugininitializercontext.opaqueid.md) | <code>PluginOpaqueId</code> | |

Loading

0 comments on commit 5a53f7f

Please sign in to comment.