add an example to fromCallback

clear · May 7, 2024 · 7fe9df1 · 7fe9df1
1 parent 3ce4ff3
commit 7fe9df1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/stream/base.ts b/src/stream/base.ts
@@ -92,6 +92,9 @@ export class StreamBase {
      * The first parameter provided to the callback (the `error`) will be emitted as an `Error`
      * atom, whilst the second parameter (the `value`) will be emitted as an `Ok` atom.
      *
+     * @example
+     * $.fromCallback((next) => someAsyncMethod(paramA, paramB, next));
+     *
      * @group Creation
      */
     static fromCallback<T, E>(cb: (next: (error: E, value: T) => unknown) => void): Stream<T, E> {