fix doc and address nits

elastic · Nov 21, 2019 · cfa27e8 · cfa27e8
1 parent b147018
commit cfa27e8
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 13 deletions.
diff --git a/...development/core/public/kibana-plugin-public.plugininitializercontext.config.md b/...development/core/public/kibana-plugin-public.plugininitializercontext.config.md
@@ -8,6 +8,6 @@
 
 ```typescript
 readonly config: {
-        get: <T = ConfigSchema>() => T;
+        get: <T extends object = ConfigSchema>() => T;
     };
 ```
diff --git a/docs/development/core/public/kibana-plugin-public.plugininitializercontext.md b/docs/development/core/public/kibana-plugin-public.plugininitializercontext.md
@@ -9,14 +9,14 @@ The available core services passed to a `PluginInitializer`
 <b>Signature:</b>
 
 ```typescript
-export interface PluginInitializerContext<ConfigSchema = unknown> 
+export interface PluginInitializerContext<ConfigSchema extends object = object> 
 ```
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [config](./kibana-plugin-public.plugininitializercontext.config.md) | <code>{</code><br/><code>        get: &lt;T = ConfigSchema&gt;() =&gt; T;</code><br/><code>    }</code> |  |
+|  [config](./kibana-plugin-public.plugininitializercontext.config.md) | <code>{</code><br/><code>        get: &lt;T extends object = 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. |
 
diff --git a/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.md b/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.md
@@ -35,7 +35,9 @@ const configSchema = schema.object({
 type ConfigType = TypeOf<typeof configSchema>;
 
 export const config: PluginConfigDescriptor<ConfigType> = {
-  exposeToBrowser: ['uiProp'],
+  exposeToBrowser: {
+    uiProp: true,
+  },
   schema: configSchema,
 };
 

diff --git a/docs/development/core/server/kibana-plugin-server.pluginconfigschema.md b/docs/development/core/server/kibana-plugin-server.pluginconfigschema.md
@@ -9,5 +9,5 @@ Dedicated type for plugin configuration schema.
 <b>Signature:</b>
 
 ```typescript
-export declare type PluginConfigSchema<T = unknown> = Type<T>;
+export declare type PluginConfigSchema<T> = Type<T>;
 ```
diff --git a/src/core/public/plugins/plugin_context.ts b/src/core/public/plugins/plugin_context.ts
@@ -30,7 +30,7 @@ import { CoreSetup, CoreStart } from '../';
  *
  * @public
  */
-export interface PluginInitializerContext<ConfigSchema = unknown> {
+export interface PluginInitializerContext<ConfigSchema extends object = object> {
   /**
    * A symbol used to identify this plugin in the system. Needed when registering handlers or context providers.
    */
@@ -40,7 +40,7 @@ export interface PluginInitializerContext<ConfigSchema = unknown> {
     packageInfo: Readonly<PackageInfo>;
   };
   readonly config: {
-    get: <T = ConfigSchema>() => T;
+    get: <T extends object = ConfigSchema>() => T;
   };
 }
 

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -695,10 +695,10 @@ export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends obje
 export type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
 
 // @public
-export interface PluginInitializerContext<ConfigSchema = unknown> {
+export interface PluginInitializerContext<ConfigSchema extends object = object> {
     // (undocumented)
     readonly config: {
-        get: <T = ConfigSchema>() => T;
+        get: <T extends object = ConfigSchema>() => T;
     };
     // (undocumented)
     readonly env: {

diff --git a/src/core/server/plugins/types.ts b/src/core/server/plugins/types.ts
@@ -29,7 +29,7 @@ import { CoreSetup, CoreStart } from '..';
  *
  * @public
  */
-export type PluginConfigSchema<T = unknown> = Type<T>;
+export type PluginConfigSchema<T> = Type<T>;
 
 /**
  * Describes a plugin configuration schema and capabilities.
@@ -48,7 +48,9 @@ export type PluginConfigSchema<T = unknown> = Type<T>;
  * type ConfigType = TypeOf<typeof configSchema>;
  *
  * export const config: PluginConfigDescriptor<ConfigType> = {
- *   exposeToBrowser: ['uiProp'],
+ *   exposeToBrowser: {
+ *     uiProp: true,
+ *   },
  *   schema: configSchema,
  * };
  * ```

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -968,7 +968,7 @@ export interface PluginConfigDescriptor<T = any> {
 }
 
 // @public
-export type PluginConfigSchema<T = unknown> = Type<T>;
+export type PluginConfigSchema<T> = Type<T>;
 
 // @public
 export type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;

diff --git a/src/plugins/testbed/server/index.ts b/src/plugins/testbed/server/index.ts
@@ -36,7 +36,7 @@ const configSchema = schema.object({
 
 type ConfigType = TypeOf<typeof configSchema>;
 
-export const config: PluginConfigDescriptor<ConfigType> = {
+export const config: PluginConfigDescriptor = {
   exposeToBrowser: {
     uiProp: true,
   },