Просмотр исходного кода

Better typing: Promise<void> -> PromiseLike<void>

Jason Grout 6 лет назад
Родитель
Сommit
ee17a1fae1

+ 6 - 6
packages/services/src/kernel/comm.ts

@@ -55,7 +55,7 @@ class CommHandler extends DisposableDelegate implements Kernel.IComm {
    *
    * **See also:** [[ICommClose]], [[close]]
    */
-  get onClose(): (msg: KernelMessage.ICommCloseMsg) => void | Promise<void> {
+  get onClose(): (msg: KernelMessage.ICommCloseMsg) => void | PromiseLike<void> {
     return this._onClose;
   }
 
@@ -70,14 +70,14 @@ class CommHandler extends DisposableDelegate implements Kernel.IComm {
    *
    * **See also:** [[close]]
    */
-  set onClose(cb: (msg: KernelMessage.ICommCloseMsg) => void | Promise<void>) {
+  set onClose(cb: (msg: KernelMessage.ICommCloseMsg) => void | PromiseLike<void>) {
     this._onClose = cb;
   }
 
   /**
    * Get the callback for a comm message received event.
    */
-  get onMsg(): (msg: KernelMessage.ICommMsgMsg) => void | Promise<void> {
+  get onMsg(): (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void> {
     return this._onMsg;
   }
 
@@ -88,7 +88,7 @@ class CommHandler extends DisposableDelegate implements Kernel.IComm {
    * This is called when a comm message is received. If the function returns a
    * promise, kernel message processing will pause until it is fulfilled.
    */
-  set onMsg(cb: (msg: KernelMessage.ICommMsgMsg) => void | Promise<void>) {
+  set onMsg(cb: (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>) {
     this._onMsg = cb;
   }
 
@@ -186,6 +186,6 @@ class CommHandler extends DisposableDelegate implements Kernel.IComm {
   private _target = '';
   private _id = '';
   private _kernel: Kernel.IKernel;
-  private _onClose: (msg: KernelMessage.ICommCloseMsg) => void | Promise<void>;
-  private _onMsg: (msg: KernelMessage.ICommMsgMsg) => void | Promise<void>;
+  private _onClose: (msg: KernelMessage.ICommCloseMsg) => void | PromiseLike<void>;
+  private _onMsg: (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>;
 }

+ 1 - 1
packages/services/src/kernel/default.ts

@@ -649,7 +649,7 @@ class DefaultKernel implements Kernel.IKernel {
    * it is to store the disposable. Since there is only one callback, you don't even
    * need to store the callback.
    */
-  registerCommTarget(targetName: string, callback: (comm: Kernel.IComm, msg: KernelMessage.ICommOpenMsg) => void | Promise<void>): IDisposable {
+  registerCommTarget(targetName: string, callback: (comm: Kernel.IComm, msg: KernelMessage.ICommOpenMsg) => void | PromiseLike<void>): IDisposable {
     this._targetRegistry[targetName] = callback;
     return new DisposableDelegate(() => {
       if (!this.isDisposed) {

+ 9 - 9
packages/services/src/kernel/future.ts

@@ -52,42 +52,42 @@ class KernelFutureHandler extends DisposableDelegate implements Kernel.IFuture {
   /**
    * Get the reply handler.
    */
-  get onReply(): (msg: KernelMessage.IShellMessage) => void | Promise<void> {
+  get onReply(): (msg: KernelMessage.IShellMessage) => void | PromiseLike<void> {
     return this._reply;
   }
 
   /**
    * Set the reply handler.
    */
-  set onReply(cb: (msg: KernelMessage.IShellMessage) => void | Promise<void>) {
+  set onReply(cb: (msg: KernelMessage.IShellMessage) => void | PromiseLike<void>) {
     this._reply = cb;
   }
 
   /**
    * Get the iopub handler.
    */
-  get onIOPub(): (msg: KernelMessage.IIOPubMessage) => void | Promise<void> {
+  get onIOPub(): (msg: KernelMessage.IIOPubMessage) => void | PromiseLike<void> {
     return this._iopub;
   }
 
   /**
    * Set the iopub handler.
    */
-  set onIOPub(cb: (msg: KernelMessage.IIOPubMessage) => void | Promise<void>) {
+  set onIOPub(cb: (msg: KernelMessage.IIOPubMessage) => void | PromiseLike<void>) {
     this._iopub = cb;
   }
 
   /**
    * Get the stdin handler.
    */
-  get onStdin(): (msg: KernelMessage.IStdinMessage) => void | Promise<void> {
+  get onStdin(): (msg: KernelMessage.IStdinMessage) => void | PromiseLike<void> {
     return this._stdin;
   }
 
   /**
    * Set the stdin handler.
    */
-  set onStdin(cb: (msg: KernelMessage.IStdinMessage) => void | Promise<void>) {
+  set onStdin(cb: (msg: KernelMessage.IStdinMessage) => void | PromiseLike<void>) {
     this._stdin = cb;
   }
 
@@ -224,9 +224,9 @@ class KernelFutureHandler extends DisposableDelegate implements Kernel.IFuture {
 
   private _msg: KernelMessage.IShellMessage;
   private _status = 0;
-  private _stdin: (msg: KernelMessage.IStdinMessage) => void | Promise<void> = Private.noOp;
-  private _iopub: (msg: KernelMessage.IIOPubMessage) => void | Promise<void> = Private.noOp;
-  private _reply: (msg: KernelMessage.IShellMessage) => void | Promise<void> = Private.noOp;
+  private _stdin: (msg: KernelMessage.IStdinMessage) => void | PromiseLike<void> = Private.noOp;
+  private _iopub: (msg: KernelMessage.IIOPubMessage) => void | PromiseLike<void> = Private.noOp;
+  private _reply: (msg: KernelMessage.IShellMessage) => void | PromiseLike<void> = Private.noOp;
   private _done = new PromiseDelegate<KernelMessage.IShellMessage>();
   private _replyMsg: KernelMessage.IShellMessage;
   private _hooks = new Private.HookList<KernelMessage.IIOPubMessage>();

+ 6 - 6
packages/services/src/kernel/kernel.ts

@@ -320,7 +320,7 @@ namespace Kernel {
      * callback will be overidden.  A registered comm target handler will take
      * precedence over a comm which specifies a `target_module`.
      */
-    registerCommTarget(targetName: string, callback: (comm: Kernel.IComm, msg: KernelMessage.ICommOpenMsg) => void | Promise<void>): IDisposable;
+    registerCommTarget(targetName: string, callback: (comm: Kernel.IComm, msg: KernelMessage.ICommOpenMsg) => void | PromiseLike<void>): IDisposable;
 
     /**
      * Register an IOPub message hook.
@@ -696,7 +696,7 @@ namespace Kernel {
      * If the handler returns a promise, message processing pauses until the
      * promise is resolved.
      */
-    onReply: (msg: KernelMessage.IShellMessage) => void | Promise<void>;
+    onReply: (msg: KernelMessage.IShellMessage) => void | PromiseLike<void>;
 
     /**
      * The stdin handler for the kernel future.
@@ -705,7 +705,7 @@ namespace Kernel {
      * If the handler returns a promise, message processing pauses until the
      * promise is resolved.
      */
-    onStdin: (msg: KernelMessage.IStdinMessage) => void | Promise<void>;
+    onStdin: (msg: KernelMessage.IStdinMessage) => void | PromiseLike<void>;
 
     /**
      * The iopub handler for the kernel future.
@@ -714,7 +714,7 @@ namespace Kernel {
      * If the handler returns a promise, message processing pauses until the
      * promise is resolved.
      */
-    onIOPub: (msg: KernelMessage.IIOPubMessage) => void | Promise<void>;
+    onIOPub: (msg: KernelMessage.IIOPubMessage) => void | PromiseLike<void>;
 
     /**
      * Register hook for IOPub messages.
@@ -769,12 +769,12 @@ namespace Kernel {
      * This is called when the comm is closed from either the server or
      * client.
      */
-    onClose: (msg: KernelMessage.ICommCloseMsg) => void | Promise<void>;
+    onClose: (msg: KernelMessage.ICommCloseMsg) => void | PromiseLike<void>;
 
     /**
      * Callback for a comm message received event.
      */
-    onMsg: (msg: KernelMessage.ICommMsgMsg) => void | Promise<void>;
+    onMsg: (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>;
 
     /**
      * Open a comm with optional data and metadata.