Merge pull request #9954 from loichuder/optional-disposable

Made disposable optional for widget extensions
jupyterlab · Mar 18, 2021 · 74d26df · 74d26df
2 parents d057c86 + 0fb6394
commit 74d26df
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/packages/docmanager/src/widgetmanager.ts b/packages/docmanager/src/widgetmanager.ts
@@ -100,7 +100,10 @@ export class DocumentWidgetManager implements IDisposable {
     // Handle widget extensions.
     const disposables = new DisposableSet();
     each(this._registry.widgetExtensions(factory.name), extender => {
-      disposables.add(extender.createNew(widget, context));
+      const disposable = extender.createNew(widget, context);
+      if (disposable) {
+        disposables.add(disposable);
+      }
     });
     Private.disposablesProperty.set(widget, disposables);
     widget.disposed.connect(this._onWidgetDisposed, this);

diff --git a/packages/docregistry/src/registry.ts b/packages/docregistry/src/registry.ts
@@ -96,7 +96,7 @@ export class DocumentRegistry implements IDisposable {
   }
 
   /**
-   * Dispose of the resources held by the document registery.
+   * Dispose of the resources held by the document registry.
    */
   dispose(): void {
     if (this.isDisposed) {
@@ -1113,7 +1113,7 @@ export namespace DocumentRegistry {
     /**
      * Create a new extension for a given widget.
      */
-    createNew(widget: T, context: IContext<U>): IDisposable;
+    createNew(widget: T, context: IContext<U>): IDisposable | void;
   }
 
   /**
@@ -1516,7 +1516,7 @@ namespace Private {
   /**
    * A no-op function.
    */
-  export function noOp() {
+  export function noOp(): void {
     /* no-op */
   }
 }