Skip to content

Commit

Permalink
updates generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pgayvallet committed Nov 20, 2019
1 parent ebfc428 commit b147018
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@

```typescript
readonly config: {
create: <T = ConfigSchema>() => Observable<T>;
get: <T = ConfigSchema>() => T;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface PluginInitializerContext<ConfigSchema = unknown>

| Property | Type | Description |
| --- | --- | --- |
| [config](./kibana-plugin-public.plugininitializercontext.config.md) | <code>{</code><br/><code> create: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T&gt;;</code><br/><code> }</code> | |
| [config](./kibana-plugin-public.plugininitializercontext.config.md) | <code>{</code><br/><code> get: &lt;T = ConfigSchema&gt;() =&gt; T;</code><br/><code> }</code> | |
| [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 @@ -9,5 +9,7 @@ List of configuration properties that will be available on the client-side plugi
<b>Signature:</b>

```typescript
exposeToBrowser?: Array<keyof T>;
exposeToBrowser?: {
[P in keyof T]?: boolean;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface PluginConfigDescriptor<T = any>

| Property | Type | Description |
| --- | --- | --- |
| [exposeToBrowser](./kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md) | <code>Array&lt;keyof T&gt;</code> | List of configuration properties that will be available on the client-side plugin. |
| [exposeToBrowser](./kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md) | <code>{</code><br/><code> [P in keyof T]?: boolean;</code><br/><code> }</code> | List of configuration properties that will be available on the client-side plugin. |
| [schema](./kibana-plugin-server.pluginconfigdescriptor.schema.md) | <code>PluginConfigSchema&lt;T&gt;</code> | Schema to use to validate the plugin configuration.[PluginConfigSchema](./kibana-plugin-server.pluginconfigschema.md) |

## Example
Expand Down
2 changes: 1 addition & 1 deletion src/core/public/public.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ export type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = obj
export interface PluginInitializerContext<ConfigSchema = unknown> {
// (undocumented)
readonly config: {
create: <T = ConfigSchema>() => Observable<T>;
get: <T = ConfigSchema>() => T;
};
// (undocumented)
readonly env: {
Expand Down
4 changes: 3 additions & 1 deletion src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,9 @@ export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends obje

// @public
export interface PluginConfigDescriptor<T = any> {
exposeToBrowser?: Array<keyof T>;
exposeToBrowser?: {
[P in keyof T]?: boolean;
};
schema: PluginConfigSchema<T>;
}

Expand Down

0 comments on commit b147018

Please sign in to comment.