fix(rstream): add note about Awaited<T> type sig (1c82afa)

thi-ng · Nov 19, 2021 · efd8647 · efd8647
1 parent 2ec8edc
commit efd8647
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/packages/rstream/src/promises.ts b/packages/rstream/src/promises.ts
@@ -4,13 +4,16 @@ import { __optsWithID } from "./idgen.js";
 import { fromPromise } from "./promise.js";
 
 /**
- * Wraps given iterable in `Promise.all()` to yield {@link Stream} of
- * results in same order as arguments, then closes.
+ * Wraps given iterable in `Promise.all()` to yield {@link Stream} of results in
+ * same order as arguments, then closes.
  *
  * @remarks
- * If any of the promises rejects, all others will do so too. In this
- * case the stream calls {@link ISubscriber.error} in all of its
- * subscribers.
+ * If any of the promises rejects, all others will do so too. In this case the
+ * stream calls {@link ISubscriber.error} in all of its subscribers.
+ *
+ * @remarks
+ * Type signature updated to use `Awaited<T>`, a new core type introduced in
+ * TypeScript 4.5.
  *
  * @example
  * ```ts