Update context examples

elastic · Oct 8, 2019 · 981432f · 981432f
1 parent 4f77267
commit 981432f
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 24 deletions.
diff --git a/docs/development/core/public/kibana-plugin-public.contextsetup.md b/docs/development/core/public/kibana-plugin-public.contextsetup.md
@@ -91,18 +91,17 @@ export interface VizRenderContext {
 }
 
 export type VizRenderer = (context: VizRenderContext, domElement: HTMLElement) => () => void;
+// When a renderer is bound via `contextContainer.createHandler` this is the type that will be returned.
+type BoundVizRenderer = (domElement: HTMLElement) => () => void;
 
 class VizRenderingPlugin {
-  private readonly vizRenderers = new Map<string, ((domElement: HTMLElement) => () => void)>();
+  private readonly contextContainer?: IContextContainer<VizRenderer>;
+  private readonly vizRenderers = new Map<string, BoundVizRenderer>();
 
   constructor(private readonly initContext: PluginInitializerContext) {}
 
   setup(core) {
-    this.contextContainer = core.context.createContextContainer<
-      VizRenderContext,
-      ReturnType<VizRenderer>,
-      [HTMLElement]
-    >();
+    this.contextContainer = core.context.createContextContainer();
 
     return {
       registerContext: this.contextContainer.registerContext,

diff --git a/docs/development/core/server/kibana-plugin-server.contextsetup.md b/docs/development/core/server/kibana-plugin-server.contextsetup.md
@@ -91,18 +91,17 @@ export interface VizRenderContext {
 }
 
 export type VizRenderer = (context: VizRenderContext, domElement: HTMLElement) => () => void;
+// When a renderer is bound via `contextContainer.createHandler` this is the type that will be returned.
+type BoundVizRenderer = (domElement: HTMLElement) => () => void;
 
 class VizRenderingPlugin {
-  private readonly vizRenderers = new Map<string, ((domElement: HTMLElement) => () => void)>();
+  private readonly contextContainer?: IContextContainer<VizRenderer>;
+  private readonly vizRenderers = new Map<string, BoundVizRenderer>();
 
   constructor(private readonly initContext: PluginInitializerContext) {}
 
   setup(core) {
-    this.contextContainer = core.context.createContextContainer<
-      VizRenderContext,
-      ReturnType<VizRenderer>,
-      [HTMLElement]
-    >();
+    this.contextContainer = core.context.createContextContainer();
 
     return {
       registerContext: this.contextContainer.registerContext,

diff --git a/src/core/public/context/context_service.ts b/src/core/public/context/context_service.ts
@@ -53,18 +53,17 @@ export class ContextService {
  * }
  *
  * export type VizRenderer = (context: VizRenderContext, domElement: HTMLElement) => () => void;
+ * // When a renderer is bound via `contextContainer.createHandler` this is the type that will be returned.
+ * type BoundVizRenderer = (domElement: HTMLElement) => () => void;
  *
  * class VizRenderingPlugin {
- *   private readonly vizRenderers = new Map<string, ((domElement: HTMLElement) => () => void)>();
+ *   private readonly contextContainer?: IContextContainer<VizRenderer>;
+ *   private readonly vizRenderers = new Map<string, BoundVizRenderer>();
  *
  *   constructor(private readonly initContext: PluginInitializerContext) {}
  *
  *   setup(core) {
- *     this.contextContainer = core.context.createContextContainer<
- *       VizRenderContext,
- *       ReturnType<VizRenderer>,
- *       [HTMLElement]
- *     >();
+ *     this.contextContainer = core.context.createContextContainer();
  *
  *     return {
  *       registerContext: this.contextContainer.registerContext,

diff --git a/src/core/server/context/context_service.ts b/src/core/server/context/context_service.ts
@@ -54,18 +54,17 @@ export class ContextService {
  * }
  *
  * export type VizRenderer = (context: VizRenderContext, domElement: HTMLElement) => () => void;
+ * // When a renderer is bound via `contextContainer.createHandler` this is the type that will be returned.
+ * type BoundVizRenderer = (domElement: HTMLElement) => () => void;
  *
  * class VizRenderingPlugin {
- *   private readonly vizRenderers = new Map<string, ((domElement: HTMLElement) => () => void)>();
+ *   private readonly contextContainer?: IContextContainer<VizRenderer>;
+ *   private readonly vizRenderers = new Map<string, BoundVizRenderer>();
  *
  *   constructor(private readonly initContext: PluginInitializerContext) {}
  *
  *   setup(core) {
- *     this.contextContainer = core.context.createContextContainer<
- *       VizRenderContext,
- *       ReturnType<VizRenderer>,
- *       [HTMLElement]
- *     >();
+ *     this.contextContainer = core.context.createContextContainer();
  *
  *     return {
  *       registerContext: this.contextContainer.registerContext,