Add IStream interface

jupyterlab · Nov 8, 2022 · 91af63a · 91af63a
1 parent dd323c4
commit 91af63a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/packages/signaling/src/index.ts b/packages/signaling/src/index.ts
@@ -85,6 +85,13 @@ export interface ISignal<T, U> {
   disconnect(slot: Slot<T, U>, thisArg?: any): boolean;
 }
 
+/**
+ * An object that is both a signal and an async iterable iterator.
+ */
+export interface IStream<T, U>
+  extends ISignal<T, U>,
+    AsyncIterableIterator<U> {}
+
 /**
  * A concrete implementation of `ISignal`.
  *
@@ -345,10 +352,7 @@ export namespace Signal {
 /**
  * A stream with the characteristics of a signal and an async iterator.
  */
-export class Stream<T, U>
-  extends Signal<T, U>
-  implements AsyncIterableIterator<U>
-{
+export class Stream<T, U> extends Signal<T, U> implements IStream<T, U> {
   /**
    * Return an async iterator that yields every emission.
    */

diff --git a/review/api/signaling.api.md b/review/api/signaling.api.md
@@ -13,6 +13,10 @@ export interface ISignal<T, U> {
     disconnect(slot: Slot<T, U>, thisArg?: any): boolean;
 }
 
+// @public
+export interface IStream<T, U> extends ISignal<T, U>, AsyncIterableIterator<U> {
+}
+
 // @public
 export class Signal<T, U> implements ISignal<T, U> {
     constructor(sender: T);
@@ -41,7 +45,7 @@ export namespace Signal {
 export type Slot<T, U> = (sender: T, args: U) => void;
 
 // @public
-export class Stream<T, U> extends Signal<T, U> implements AsyncIterableIterator<U> {
+export class Stream<T, U> extends Signal<T, U> implements IStream<T, U> {
     [Symbol.asyncIterator](): AsyncIterableIterator<U>;
     emit(args: U): void;
     next(): Promise<IteratorResult<U>>;