synstate 0.1.0 → 0.1.2

package/dist/core/operators/take-while.d.mts

@@ -1,4 +1,50 @@
 import { type DropInitialValueOperator } from '../types/index.mjs';
+/**
+ * Emits values from the source observable while the predicate returns true.
+ * Completes immediately when the predicate returns false.
+ *
+ * @template A - The type of values from the source
+ * @param predicate - Function to test each value
+ * @returns An operator that takes values while the predicate is true
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  num$      1     2     3     4     5     6 (ignored)
+ * //  taken$    1     2     3     4     | (completes)
+ * //
+ * //  Explanation:
+ * //  - takeWhile emits values while the predicate returns true
+ * //  - Completes immediately when the predicate returns false
+ * //  - No further values are emitted after completion
+ *
+ * const num$ = source<number>();
+ *
+ * const taken$ = num$.pipe(takeWhile((x) => x < 5));
+ *
+ * const mut_history: number[] = [];
+ *
+ * taken$.subscribe((x) => {
+ *   mut_history.push(x);
+ * });
+ *
+ * num$.next(1); // logs: 1
+ *
+ * assert.deepStrictEqual(mut_history, [1]);
+ *
+ * num$.next(2); // logs: 2
+ *
+ * assert.deepStrictEqual(mut_history, [1, 2]);
+ *
+ * num$.next(5); // nothing logged (completes)
+ *
+ * assert.deepStrictEqual(mut_history, [1, 2]);
+ *
+ * num$.next(6); // nothing logged (already completed)
+ *
+ * assert.deepStrictEqual(mut_history, [1, 2]);
+ * ```
+ */
 export declare const takeWhile: <A>(predicate: (value: A, index: SafeUint | -1) => boolean) => DropInitialValueOperator<A, A>;
-export declare const take: <A>(n: PositiveSafeIntWithSmallInt) => DropInitialValueOperator<A, A>;
 //# sourceMappingURL=take-while.d.mts.map

package/dist/core/operators/take-while.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"take-while.d.mts","sourceRoot":"","sources":["../../../src/core/operators/take-while.mts"],"names":[],"mappings":"AASA,OAAO,EACL,KAAK,wBAAwB,EAK9B,MAAM,oBAAoB,CAAC;AAG5B,eAAO,MAAM,SAAS,GACnB,CAAC,EACA,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,GAAG,CAAC,CAAC,KAAK,OAAO,KACrD,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAE2B,CAAC;AAI9D,eAAO,MAAM,IAAI,GAAI,CAAC,EACpB,GAAG,2BAA2B,KAC7B,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAA4C,CAAC"}
+{"version":3,"file":"take-while.d.mts","sourceRoot":"","sources":["../../../src/core/operators/take-while.mts"],"names":[],"mappings":"AASA,OAAO,EACL,KAAK,wBAAwB,EAK9B,MAAM,oBAAoB,CAAC;AAG5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,eAAO,MAAM,SAAS,GACnB,CAAC,EACA,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,GAAG,CAAC,CAAC,KAAK,OAAO,KACrD,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAE2B,CAAC"}

package/dist/core/operators/take-while.mjs

@@ -2,9 +2,54 @@ import { pipe, Optional, asSafeUint, SafeUint } from 'ts-data-forge';
 import { SyncChildObservableClass } from '../class/child-observable-class.mjs';
 import '../utils/id-maker.mjs';
 
+/**
+ * Emits values from the source observable while the predicate returns true.
+ * Completes immediately when the predicate returns false.
+ *
+ * @template A - The type of values from the source
+ * @param predicate - Function to test each value
+ * @returns An operator that takes values while the predicate is true
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  num$      1     2     3     4     5     6 (ignored)
+ * //  taken$    1     2     3     4     | (completes)
+ * //
+ * //  Explanation:
+ * //  - takeWhile emits values while the predicate returns true
+ * //  - Completes immediately when the predicate returns false
+ * //  - No further values are emitted after completion
+ *
+ * const num$ = source<number>();
+ *
+ * const taken$ = num$.pipe(takeWhile((x) => x < 5));
+ *
+ * const mut_history: number[] = [];
+ *
+ * taken$.subscribe((x) => {
+ *   mut_history.push(x);
+ * });
+ *
+ * num$.next(1); // logs: 1
+ *
+ * assert.deepStrictEqual(mut_history, [1]);
+ *
+ * num$.next(2); // logs: 2
+ *
+ * assert.deepStrictEqual(mut_history, [1, 2]);
+ *
+ * num$.next(5); // nothing logged (completes)
+ *
+ * assert.deepStrictEqual(mut_history, [1, 2]);
+ *
+ * num$.next(6); // nothing logged (already completed)
+ *
+ * assert.deepStrictEqual(mut_history, [1, 2]);
+ * ```
+ */
 const takeWhile = (predicate) => (parentObservable) => new TakeWhileObservableClass(parentObservable, predicate);
-/* Specialized operators */
-const take = (n) => takeWhile((_, index) => index + 1 <= n);
 /* implementation */
 class TakeWhileObservableClass extends SyncChildObservableClass {
     #predicate;
@@ -38,5 +83,5 @@ class TakeWhileObservableClass extends SyncChildObservableClass {
     }
 }
 
-export { take, takeWhile };
+export { takeWhile };
 //# sourceMappingURL=take-while.mjs.map

package/dist/core/operators/take-while.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"take-while.mjs","sources":["../../../src/core/operators/take-while.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAkBO,MAAM,SAAS,GACpB,CACE,SAAsD,KAExD,CAAC,gBAAgB,KACf,IAAI,wBAAwB,CAAC,gBAAgB,EAAE,SAAS;AAE5D;MAEa,IAAI,GAAG,CAClB,CAA8B,KACK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,KAAK,GAAG,CAAC,IAAI,CAAC;AAE3E;AAEA,MAAM,wBACJ,SAAQ,wBAAyC,CAAA;AAGxC,IAAA,UAAU;AACnB,IAAA,UAAU;IAEV,WAAA,CACE,gBAA+B,EAC/B,SAAsD,EAAA;AAEtD,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;YAC3B,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KACzD,QAAQ,CAAC,MAAM,CAAC,GAAG;kBACf,QAAQ,CAAC;kBACT,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;AACvB,sBAAE;AACF,sBAAE,QAAQ,CAAC,IAAI,CACpB,CAAC,KAAK;AACR,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,UAAU,GAAG,EAAE;AAEpB,QAAA,IAAI,CAAC,UAAU,GAAG,SAAS;;AAGpB,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;;AAGT,QAAA,IAAI,CAAC,UAAU;YACb,IAAI,CAAC,UAAU,KAAK,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;AAE3E,QAAA,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE;YAC9C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC;;aAChC;YACL,IAAI,CAAC,QAAQ,EAAE;;;AAGpB;;;;"}
+{"version":3,"file":"take-while.mjs","sources":["../../../src/core/operators/take-while.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CG;AACI,MAAM,SAAS,GACpB,CACE,SAAsD,KAExD,CAAC,gBAAgB,KACf,IAAI,wBAAwB,CAAC,gBAAgB,EAAE,SAAS;AAE5D;AAEA,MAAM,wBACJ,SAAQ,wBAAyC,CAAA;AAGxC,IAAA,UAAU;AACnB,IAAA,UAAU;IAEV,WAAA,CACE,gBAA+B,EAC/B,SAAsD,EAAA;AAEtD,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;YAC3B,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KACzD,QAAQ,CAAC,MAAM,CAAC,GAAG;kBACf,QAAQ,CAAC;kBACT,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;AACvB,sBAAE;AACF,sBAAE,QAAQ,CAAC,IAAI,CACpB,CAAC,KAAK;AACR,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,UAAU,GAAG,EAAE;AAEpB,QAAA,IAAI,CAAC,UAAU,GAAG,SAAS;;AAGpB,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;;AAGT,QAAA,IAAI,CAAC,UAAU;YACb,IAAI,CAAC,UAAU,KAAK,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;AAE3E,QAAA,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE;YAC9C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC;;aAChC;YACL,IAAI,CAAC,QAAQ,EAAE;;;AAGpB;;;;"}

package/dist/core/operators/throttle-time.d.mts

@@ -9,14 +9,53 @@ import { type KeepInitialValueOperator } from '../types/index.mjs';
  *
  * @example
  * ```ts
- * const scroll$ = source<Event>();
+ * //  Timeline (1000ms throttle):
+ * //
+ * //  Time(ms)  0    100   200   300   ...   1000  1100  1200  ...   2000  2100
+ * //  scroll$   e1   e2    e3    e4          e5    e6    e7          e8    e9
+ * //  throttled$ e1                          e5                      e8
+ * //             |-------1000ms------>       |------1000ms------>    |------1000ms------>
+ * //
+ * //  Explanation:
+ * //  - throttleTime emits the first value immediately, then ignores subsequent values
+ * //    for the specified duration (1000ms)
+ * //  - At 0ms: e1 is emitted immediately
+ * //  - At 100-300ms: e2, e3, e4 are ignored (within 1000ms window)
+ * //  - At 1000ms: e5 is emitted (1000ms has passed since e1)
+ * //  - At 1100-1200ms: e6, e7 are ignored
+ * //  - At 2000ms: e8 is emitted (1000ms has passed since e5)
  *
- * const throttled$ = scroll$.pipe(throttleTime(1000));
+ * const scroll$ = source<number>();
  *
- * throttled$.subscribe((event_) => {
- *   console.log(event_);
+ * const throttled$ = scroll$.pipe(throttleTime(200));
+ *
+ * const mut_history: number[] = [];
+ *
+ * throttled$.subscribe((value) => {
+ *   mut_history.push(value);
  * });
- * // Emits at most once per second
+ *
+ * scroll$.next(1);
+ *
+ * assert.deepStrictEqual(mut_history, [1]);
+ *
+ * await new Promise((resolve) => {
+ *   setTimeout(resolve, 50);
+ * });
+ *
+ * scroll$.next(2);
+ *
+ * scroll$.next(3);
+ *
+ * assert.deepStrictEqual(mut_history, [1]);
+ *
+ * await new Promise((resolve) => {
+ *   setTimeout(resolve, 200);
+ * });
+ *
+ * scroll$.next(4);
+ *
+ * assert.deepStrictEqual(mut_history, [1, 4]);
  * ```
  */
 export declare const throttleTime: <A>(milliSeconds: number) => KeepInitialValueOperator<A, A>;

package/dist/core/operators/throttle-time.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"throttle-time.d.mts","sourceRoot":"","sources":["../../../src/core/operators/throttle-time.mts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,wBAAwB,EAI9B,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,EAC5B,cAAc,MAAM,KACnB,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAMQ,CAAC"}
+{"version":3,"file":"throttle-time.d.mts","sourceRoot":"","sources":["../../../src/core/operators/throttle-time.mts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,wBAAwB,EAI9B,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,EAC5B,cAAc,MAAM,KACnB,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAMQ,CAAC"}

package/dist/core/operators/throttle-time.mjs

@@ -12,14 +12,53 @@ import '../utils/id-maker.mjs';
  *
  * @example
  * ```ts
- * const scroll$ = source<Event>();
+ * //  Timeline (1000ms throttle):
+ * //
+ * //  Time(ms)  0    100   200   300   ...   1000  1100  1200  ...   2000  2100
+ * //  scroll$   e1   e2    e3    e4          e5    e6    e7          e8    e9
+ * //  throttled$ e1                          e5                      e8
+ * //             |-------1000ms------>       |------1000ms------>    |------1000ms------>
+ * //
+ * //  Explanation:
+ * //  - throttleTime emits the first value immediately, then ignores subsequent values
+ * //    for the specified duration (1000ms)
+ * //  - At 0ms: e1 is emitted immediately
+ * //  - At 100-300ms: e2, e3, e4 are ignored (within 1000ms window)
+ * //  - At 1000ms: e5 is emitted (1000ms has passed since e1)
+ * //  - At 1100-1200ms: e6, e7 are ignored
+ * //  - At 2000ms: e8 is emitted (1000ms has passed since e5)
  *
- * const throttled$ = scroll$.pipe(throttleTime(1000));
+ * const scroll$ = source<number>();
  *
- * throttled$.subscribe((event_) => {
- *   console.log(event_);
+ * const throttled$ = scroll$.pipe(throttleTime(200));
+ *
+ * const mut_history: number[] = [];
+ *
+ * throttled$.subscribe((value) => {
+ *   mut_history.push(value);
  * });
- * // Emits at most once per second
+ *
+ * scroll$.next(1);
+ *
+ * assert.deepStrictEqual(mut_history, [1]);
+ *
+ * await new Promise((resolve) => {
+ *   setTimeout(resolve, 50);
+ * });
+ *
+ * scroll$.next(2);
+ *
+ * scroll$.next(3);
+ *
+ * assert.deepStrictEqual(mut_history, [1]);
+ *
+ * await new Promise((resolve) => {
+ *   setTimeout(resolve, 200);
+ * });
+ *
+ * scroll$.next(4);
+ *
+ * assert.deepStrictEqual(mut_history, [1, 4]);
  * ```
  */
 const throttleTime = (milliSeconds) => 

package/dist/core/operators/throttle-time.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"throttle-time.mjs","sources":["../../../src/core/operators/throttle-time.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;AASA;;;;;;;;;;;;;;;;;;;AAmBG;AACI,MAAM,YAAY,GAAG,CAC1B,YAAoB;AAEpB;AACA,CAAC,CAAC,gBAAgB,KAChB,IAAI,2BAA2B,CAC7B,gBAAgB,EAChB,YAAY,CACb;AAEL,MAAM,2BACJ,SAAQ,wBAAyC,CAAA;AAGxC,IAAA,aAAa;AACtB,IAAA,YAAY;AACZ,IAAA,eAAe;IAEf,WAAA,CAAY,gBAA+B,EAAE,YAAoB,EAAA;AAC/D,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;AAC3B,YAAA,YAAY,EAAE,gBAAgB,CAAC,WAAW,EAAE;AAC7C,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,YAAY,GAAG,SAAS;AAE7B,QAAA,IAAI,CAAC,eAAe,GAAG,KAAK;AAE5B,QAAA,IAAI,CAAC,aAAa,GAAG,YAAY;IACnC;AAES,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IACE,GAAG,CAAC,aAAa,KAAK,aAAa;AACnC,YAAA,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,eAAe,EACpB;AACA,YAAA,OAAO;QACT;QAEA,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC;AAErC,QAAA,IAAI,CAAC,eAAe,GAAG,IAAI;;AAG3B,QAAA,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,MAAK;AAClC,YAAA,IAAI,CAAC,eAAe,GAAG,KAAK;AAC9B,QAAA,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC;IACxB;IAEA,WAAW,GAAA;AACT,QAAA,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;AACnC,YAAA,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC;QACjC;IACF;IAES,QAAQ,GAAA;QACf,IAAI,CAAC,WAAW,EAAE;QAElB,KAAK,CAAC,QAAQ,EAAE;IAClB;AACD;;;;"}
+{"version":3,"file":"throttle-time.mjs","sources":["../../../src/core/operators/throttle-time.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;AASA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DG;AACI,MAAM,YAAY,GAAG,CAC1B,YAAoB;AAEpB;AACA,CAAC,CAAC,gBAAgB,KAChB,IAAI,2BAA2B,CAC7B,gBAAgB,EAChB,YAAY,CACb;AAEL,MAAM,2BACJ,SAAQ,wBAAyC,CAAA;AAGxC,IAAA,aAAa;AACtB,IAAA,YAAY;AACZ,IAAA,eAAe;IAEf,WAAA,CAAY,gBAA+B,EAAE,YAAoB,EAAA;AAC/D,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;AAC3B,YAAA,YAAY,EAAE,gBAAgB,CAAC,WAAW,EAAE;AAC7C,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,YAAY,GAAG,SAAS;AAE7B,QAAA,IAAI,CAAC,eAAe,GAAG,KAAK;AAE5B,QAAA,IAAI,CAAC,aAAa,GAAG,YAAY;IACnC;AAES,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IACE,GAAG,CAAC,aAAa,KAAK,aAAa;AACnC,YAAA,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,eAAe,EACpB;AACA,YAAA,OAAO;QACT;QAEA,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC;AAErC,QAAA,IAAI,CAAC,eAAe,GAAG,IAAI;;AAG3B,QAAA,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,MAAK;AAClC,YAAA,IAAI,CAAC,eAAe,GAAG,KAAK;AAC9B,QAAA,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC;IACxB;IAEA,WAAW,GAAA;AACT,QAAA,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;AACnC,YAAA,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC;QACjC;IACF;IAES,QAAQ,GAAA;QACf,IAAI,CAAC,WAAW,EAAE;QAElB,KAAK,CAAC,QAAQ,EAAE;IAClB;AACD;;;;"}

package/dist/core/operators/with-buffered-from.d.mts

@@ -1,4 +1,61 @@
 import { type KeepInitialValueOperator, type Observable } from '../types/index.mjs';
+/**
+ * Buffers values from the source observable and emits them along with the parent value
+ * when the parent emits. The buffer is cleared after each emission.
+ *
+ * @template A - The type of values from the parent observable
+ * @template B - The type of values from the source observable
+ * @param observable - The observable whose values will be buffered
+ * @returns An operator that emits tuples of [parentValue, bufferedValues]
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  data$       d1    d2    d3    d4    d5    d6    d7    d8
+ * //  trigger$                T1                T2                T3
+ * //  result$                 [T1,[d1,d2,d3]]   [T2,[d4,d5,d6]]   [T3,[d7,d8]]
+ * //
+ * //  Explanation:
+ * //  - withBufferedFrom collects values from the source observable
+ * //  - When the trigger emits, it emits a tuple of [triggerValue, bufferedValues]
+ * //  - Buffer is cleared after each emission
+ * //  - Useful for batching data collection triggered by events
+ *
+ * const data$ = source<string>();
+ *
+ * const trigger$ = source<number>();
+ *
+ * const result$ = trigger$.pipe(withBufferedFrom(data$));
+ *
+ * const mut_history: (readonly [number, readonly string[]])[] = [];
+ *
+ * result$.subscribe(([triggerValue, bufferedData]) => {
+ *   mut_history.push([triggerValue, bufferedData]);
+ * });
+ *
+ * data$.next('a');
+ *
+ * data$.next('b');
+ *
+ * trigger$.next(1);
+ *
+ * assert.deepStrictEqual(mut_history, [[1, ['a', 'b']]]);
+ *
+ * data$.next('c');
+ *
+ * trigger$.next(2);
+ *
+ * assert.deepStrictEqual(mut_history, [
+ *   [1, ['a', 'b']],
+ *   [2, ['c']],
+ * ]);
+ * ```
+ */
 export declare const withBufferedFrom: <A, B>(observable: Observable<B>) => KeepInitialValueOperator<A, readonly [A, readonly B[]]>;
+/**
+ * Alias for `withBufferedFrom`.
+ * @see withBufferedFrom
+ */
 export declare const withBuffered: <A, B>(observable: Observable<B>) => KeepInitialValueOperator<A, readonly [A, readonly B[]]>;
 //# sourceMappingURL=with-buffered-from.d.mts.map

package/dist/core/operators/with-buffered-from.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"with-buffered-from.d.mts","sourceRoot":"","sources":["../../../src/core/operators/with-buffered-from.mts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EAGhB,MAAM,oBAAoB,CAAC;AAG5B,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,CAAC,EACnC,YAAY,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAMQ,CAAC;AAElE,eAAO,MAAM,YAAY,GAVQ,CAAC,EAAE,CAAC,cACvB,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAQb,CAAC"}
+{"version":3,"file":"with-buffered-from.d.mts","sourceRoot":"","sources":["../../../src/core/operators/with-buffered-from.mts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EAGhB,MAAM,oBAAoB,CAAC;AAG5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,CAAC,EACnC,YAAY,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAMQ,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,YAAY,GAdQ,CAAC,EAAE,CAAC,cACvB,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAYb,CAAC"}

package/dist/core/operators/with-buffered-from.mjs

@@ -3,10 +3,67 @@ import { SyncChildObservableClass } from '../class/child-observable-class.mjs';
 import '../utils/id-maker.mjs';
 import { maxDepth } from '../utils/max-depth.mjs';
 
+/**
+ * Buffers values from the source observable and emits them along with the parent value
+ * when the parent emits. The buffer is cleared after each emission.
+ *
+ * @template A - The type of values from the parent observable
+ * @template B - The type of values from the source observable
+ * @param observable - The observable whose values will be buffered
+ * @returns An operator that emits tuples of [parentValue, bufferedValues]
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  data$       d1    d2    d3    d4    d5    d6    d7    d8
+ * //  trigger$                T1                T2                T3
+ * //  result$                 [T1,[d1,d2,d3]]   [T2,[d4,d5,d6]]   [T3,[d7,d8]]
+ * //
+ * //  Explanation:
+ * //  - withBufferedFrom collects values from the source observable
+ * //  - When the trigger emits, it emits a tuple of [triggerValue, bufferedValues]
+ * //  - Buffer is cleared after each emission
+ * //  - Useful for batching data collection triggered by events
+ *
+ * const data$ = source<string>();
+ *
+ * const trigger$ = source<number>();
+ *
+ * const result$ = trigger$.pipe(withBufferedFrom(data$));
+ *
+ * const mut_history: (readonly [number, readonly string[]])[] = [];
+ *
+ * result$.subscribe(([triggerValue, bufferedData]) => {
+ *   mut_history.push([triggerValue, bufferedData]);
+ * });
+ *
+ * data$.next('a');
+ *
+ * data$.next('b');
+ *
+ * trigger$.next(1);
+ *
+ * assert.deepStrictEqual(mut_history, [[1, ['a', 'b']]]);
+ *
+ * data$.next('c');
+ *
+ * trigger$.next(2);
+ *
+ * assert.deepStrictEqual(mut_history, [
+ *   [1, ['a', 'b']],
+ *   [2, ['c']],
+ * ]);
+ * ```
+ */
 const withBufferedFrom = (observable) => 
 // eslint-disable-next-line total-functions/no-unsafe-type-assertion
 ((parentObservable) => new WithBufferedFromObservableClass(parentObservable, observable));
-const withBuffered = withBufferedFrom; // alias
+/**
+ * Alias for `withBufferedFrom`.
+ * @see withBufferedFrom
+ */
+const withBuffered = withBufferedFrom;
 class WithBufferedFromObservableClass extends SyncChildObservableClass {
     #mut_bufferedValues = [];
     constructor(parentObservable, observable) {

package/dist/core/operators/with-buffered-from.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"with-buffered-from.mjs","sources":["../../../src/core/operators/with-buffered-from.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAUO,MAAM,gBAAgB,GAAG,CAC9B,UAAyB;AAEzB;AACA,CAAC,CAAC,gBAAgB,KAChB,IAAI,+BAA+B,CACjC,gBAAgB,EAChB,UAAU,CACX;AAEE,MAAM,YAAY,GAAG,iBAAiB;AAE7C,MAAM,+BACJ,SAAQ,wBAAkE,CAAA;IAG1E,mBAAmB,GAAiB,EAAE;IAEtC,WAAA,CAAY,gBAA+B,EAAE,UAAyB,EAAA;AACpE,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;YAC3B,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YACnD,YAAY,EAAE,IAAI,CAAC;AACjB,gBAAA,GAAG,EAAE,gBAAgB,CAAC,WAAW,EAAE;AACnC,gBAAA,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE;AAC7B,aAAA,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,KACjB,QAAQ,CAAC,MAAM,CAAC,GAAG;kBACf,QAAQ,CAAC;AACX,kBAAE,QAAQ,CAAC,IAAI,CAAC;AACZ,oBAAA,GAAG,CAAC,KAAK;AACT,oBAAA,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC;iBAC7B,CAAC,CAChB,CAAC,KAAK;AACR,SAAA,CAAC;AAEF,QAAA,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,KAAI;AAC7B,YAAA,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC;AAC1E,QAAA,CAAC,CAAC;IACJ;AAES,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;QACT;AAEA,QAAA,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAE,aAAa,CAAC;QAEjE,IAAI,CAAC,YAAY,EAAE;IACrB;IAEA,YAAY,GAAA;AACV,QAAA,IAAI,CAAC,mBAAmB,GAAG,EAAE;IAC/B;AACD;;;;"}
+{"version":3,"file":"with-buffered-from.mjs","sources":["../../../src/core/operators/with-buffered-from.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDG;AACI,MAAM,gBAAgB,GAAG,CAC9B,UAAyB;AAEzB;AACA,CAAC,CAAC,gBAAgB,KAChB,IAAI,+BAA+B,CACjC,gBAAgB,EAChB,UAAU,CACX;AAEL;;;AAGG;AACI,MAAM,YAAY,GAAG;AAE5B,MAAM,+BACJ,SAAQ,wBAAkE,CAAA;IAG1E,mBAAmB,GAAiB,EAAE;IAEtC,WAAA,CAAY,gBAA+B,EAAE,UAAyB,EAAA;AACpE,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;YAC3B,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YACnD,YAAY,EAAE,IAAI,CAAC;AACjB,gBAAA,GAAG,EAAE,gBAAgB,CAAC,WAAW,EAAE;AACnC,gBAAA,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE;AAC7B,aAAA,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,KACjB,QAAQ,CAAC,MAAM,CAAC,GAAG;kBACf,QAAQ,CAAC;AACX,kBAAE,QAAQ,CAAC,IAAI,CAAC;AACZ,oBAAA,GAAG,CAAC,KAAK;AACT,oBAAA,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC;iBAC7B,CAAC,CAChB,CAAC,KAAK;AACR,SAAA,CAAC;AAEF,QAAA,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,KAAI;AAC7B,YAAA,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC;AAC1E,QAAA,CAAC,CAAC;IACJ;AAES,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;QACT;AAEA,QAAA,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAE,aAAa,CAAC;QAEjE,IAAI,CAAC,YAAY,EAAE;IACrB;IAEA,YAAY,GAAA;AACV,QAAA,IAAI,CAAC,mBAAmB,GAAG,EAAE;IAC/B;AACD;;;;"}

package/dist/core/operators/with-current-value-from.d.mts

@@ -1,4 +1,63 @@
 import { type DropInitialValueOperator, type Observable } from '../types/index.mjs';
+/**
+ * Samples the current value from another observable each time the source emits.
+ * Emits a tuple of [sourceValue, sampledValue].
+ *
+ * @template A - The type of values from the source observable
+ * @template B - The type of values from the sampled observable
+ * @param observable - The observable to sample from
+ * @returns An operator that emits tuples of source and sampled values
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  name$     "Alice"           "Bob"               "Charlie"
+ * //  age$                25              30      35              40
+ * //  result$             ["Alice",25]  ["Bob",30]  ["Bob",35]  ["Charlie",40]
+ * //
+ * //  Explanation:
+ * //  - withCurrentValueFrom samples the current value from another observable
+ * //  - Emits a tuple [sourceValue, sampledValue] each time the source emits
+ * //  - Does not emit until both observables have emitted at least once
+ * //  - Similar to combine, but only emits when the source (not the sampled) emits
+ *
+ * const name$ = source<string>();
+ *
+ * const age$ = source<number>();
+ *
+ * const result$ = name$.pipe(withCurrentValueFrom(age$));
+ *
+ * const mut_history: (readonly [string, number])[] = [];
+ *
+ * result$.subscribe(([name_, currentAge]) => {
+ *   mut_history.push([name_, currentAge]);
+ * });
+ *
+ * name$.next('Alice'); // nothing logged (age$ hasn't emitted)
+ *
+ * assert.deepStrictEqual(mut_history, []);
+ *
+ * age$.next(25);
+ *
+ * name$.next('Bob'); // logs: Bob is 25 years old
+ *
+ * assert.deepStrictEqual(mut_history, [['Bob', 25]]);
+ *
+ * age$.next(30);
+ *
+ * name$.next('Charlie'); // logs: Charlie is 30 years old
+ *
+ * assert.deepStrictEqual(mut_history, [
+ *   ['Bob', 25],
+ *   ['Charlie', 30],
+ * ]);
+ * ```
+ */
 export declare const withCurrentValueFrom: <A, B>(observable: Observable<B>) => DropInitialValueOperator<A, readonly [A, B]>;
+/**
+ * Alias for `withCurrentValueFrom`.
+ * @see withCurrentValueFrom
+ */
 export declare const withLatestFrom: <A, B>(observable: Observable<B>) => DropInitialValueOperator<A, readonly [A, B]>;
 //# sourceMappingURL=with-current-value-from.d.mts.map

package/dist/core/operators/with-current-value-from.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"with-current-value-from.d.mts","sourceRoot":"","sources":["../../../src/core/operators/with-current-value-from.mts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EAGhB,MAAM,oBAAoB,CAAC;AAG5B,eAAO,MAAM,oBAAoB,GAC9B,CAAC,EAAE,CAAC,EACH,YAAY,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAEyB,CAAC;AAE1E,eAAO,MAAM,cAAc,GANxB,CAAC,EAAE,CAAC,cACS,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAIE,CAAC"}
+{"version":3,"file":"with-current-value-from.d.mts","sourceRoot":"","sources":["../../../src/core/operators/with-current-value-from.mts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EAGhB,MAAM,oBAAoB,CAAC;AAG5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,eAAO,MAAM,oBAAoB,GAC9B,CAAC,EAAE,CAAC,EACH,YAAY,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAEyB,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,cAAc,GAVxB,CAAC,EAAE,CAAC,cACS,UAAU,CAAC,CAAC,CAAC,KACxB,wBAAwB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAQE,CAAC"}

package/dist/core/operators/with-current-value-from.mjs

@@ -3,8 +3,67 @@ import { SyncChildObservableClass } from '../class/child-observable-class.mjs';
 import '../utils/id-maker.mjs';
 import { maxDepth } from '../utils/max-depth.mjs';
 
+/**
+ * Samples the current value from another observable each time the source emits.
+ * Emits a tuple of [sourceValue, sampledValue].
+ *
+ * @template A - The type of values from the source observable
+ * @template B - The type of values from the sampled observable
+ * @param observable - The observable to sample from
+ * @returns An operator that emits tuples of source and sampled values
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  name$     "Alice"           "Bob"               "Charlie"
+ * //  age$                25              30      35              40
+ * //  result$             ["Alice",25]  ["Bob",30]  ["Bob",35]  ["Charlie",40]
+ * //
+ * //  Explanation:
+ * //  - withCurrentValueFrom samples the current value from another observable
+ * //  - Emits a tuple [sourceValue, sampledValue] each time the source emits
+ * //  - Does not emit until both observables have emitted at least once
+ * //  - Similar to combine, but only emits when the source (not the sampled) emits
+ *
+ * const name$ = source<string>();
+ *
+ * const age$ = source<number>();
+ *
+ * const result$ = name$.pipe(withCurrentValueFrom(age$));
+ *
+ * const mut_history: (readonly [string, number])[] = [];
+ *
+ * result$.subscribe(([name_, currentAge]) => {
+ *   mut_history.push([name_, currentAge]);
+ * });
+ *
+ * name$.next('Alice'); // nothing logged (age$ hasn't emitted)
+ *
+ * assert.deepStrictEqual(mut_history, []);
+ *
+ * age$.next(25);
+ *
+ * name$.next('Bob'); // logs: Bob is 25 years old
+ *
+ * assert.deepStrictEqual(mut_history, [['Bob', 25]]);
+ *
+ * age$.next(30);
+ *
+ * name$.next('Charlie'); // logs: Charlie is 30 years old
+ *
+ * assert.deepStrictEqual(mut_history, [
+ *   ['Bob', 25],
+ *   ['Charlie', 30],
+ * ]);
+ * ```
+ */
 const withCurrentValueFrom = (observable) => (parentObservable) => new WithCurrentValueFromObservableClass(parentObservable, observable);
-const withLatestFrom = withCurrentValueFrom; // alias
+/**
+ * Alias for `withCurrentValueFrom`.
+ * @see withCurrentValueFrom
+ */
+const withLatestFrom = withCurrentValueFrom;
 class WithCurrentValueFromObservableClass extends SyncChildObservableClass {
     #observable;
     constructor(parentObservable, observable) {

package/dist/core/operators/with-current-value-from.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"with-current-value-from.mjs","sources":["../../../src/core/operators/with-current-value-from.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;MAUa,oBAAoB,GAC/B,CACE,UAAyB,KAE3B,CAAC,gBAAgB,KACf,IAAI,mCAAmC,CAAC,gBAAgB,EAAE,UAAU;AAEjE,MAAM,cAAc,GAAG,qBAAqB;AAEnD,MAAM,mCACJ,SAAQ,wBAAuD,CAAA;AAGtD,IAAA,WAAW;IAEpB,WAAA,CAAY,gBAA+B,EAAE,UAAyB,EAAA;AACpE,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;YAC3B,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YACnD,YAAY,EAAE,IAAI,CAAC;AACjB,gBAAA,GAAG,EAAE,gBAAgB,CAAC,WAAW,EAAE;AACnC,gBAAA,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE;aAC7B,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,KACjB,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE;kBACtC,QAAQ,CAAC;AACX,kBAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAU,CAAC,CAClD,CAAC,KAAK;AACR,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,WAAW,GAAG,UAAU;IAC/B;AAES,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;QACT;QAEA,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;AAE3C,QAAA,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;AAAE,YAAA,OAAO;AAElC,QAAA,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IACrD;AACD;;;;"}
+{"version":3,"file":"with-current-value-from.mjs","sources":["../../../src/core/operators/with-current-value-from.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsDG;MACU,oBAAoB,GAC/B,CACE,UAAyB,KAE3B,CAAC,gBAAgB,KACf,IAAI,mCAAmC,CAAC,gBAAgB,EAAE,UAAU;AAExE;;;AAGG;AACI,MAAM,cAAc,GAAG;AAE9B,MAAM,mCACJ,SAAQ,wBAAuD,CAAA;AAGtD,IAAA,WAAW;IAEpB,WAAA,CAAY,gBAA+B,EAAE,UAAyB,EAAA;AACpE,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;YAC3B,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YACnD,YAAY,EAAE,IAAI,CAAC;AACjB,gBAAA,GAAG,EAAE,gBAAgB,CAAC,WAAW,EAAE;AACnC,gBAAA,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE;aAC7B,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,KACjB,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE;kBACtC,QAAQ,CAAC;AACX,kBAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAU,CAAC,CAClD,CAAC,KAAK;AACR,SAAA,CAAC;AAEF,QAAA,IAAI,CAAC,WAAW,GAAG,UAAU;IAC/B;AAES,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;QACT;QAEA,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;AAE3C,QAAA,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;AAAE,YAAA,OAAO;AAElC,QAAA,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IACrD;AACD;;;;"}

package/dist/core/operators/with-initial-value.d.mts

@@ -11,15 +11,37 @@ import { type WithInitialValueOperator } from '../types/index.mjs';
  *
  * @example
  * ```ts
+ * //  Timeline:
+ * //
+ * //  num$             1    2    3
+ * //  withInitial$ 0   1    2    3
+ * //               ^
+ * //               initial value
+ * //
+ * //  Explanation:
+ * //  - withInitialValue provides an initial value before the source emits
+ * //  - Converts an uninitialized observable to an initialized one
+ * //  - Useful when you need a default value immediately
+ *
  * const num$ = source<number>();
  *
  * const initialized$ = num$.pipe(withInitialValue(0));
  *
+ * const mut_history: number[] = [];
+ *
  * initialized$.subscribe((x) => {
- *   console.log(x);
- * }); // immediately logs: 0
+ *   mut_history.push(x);
+ * });
+ *
+ * assert.deepStrictEqual(mut_history, [0]);
  *
  * num$.next(1); // logs: 1
+ *
+ * assert.deepStrictEqual(mut_history, [0, 1]);
+ *
+ * num$.next(2); // logs: 2
+ *
+ * assert.deepStrictEqual(mut_history, [0, 1, 2]);
  * ```
  */
 export declare const withInitialValue: <A, I = A>(initialValue: I) => WithInitialValueOperator<A, A | I>;

package/dist/core/operators/with-initial-value.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"with-initial-value.d.mts","sourceRoot":"","sources":["../../../src/core/operators/with-initial-value.mts"],"names":[],"mappings":"AAGA,OAAO,EAIL,KAAK,wBAAwB,EAE9B,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,gBAAgB,GAC1B,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC,KAAG,wBAAwB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAEO,CAAC"}
+{"version":3,"file":"with-initial-value.d.mts","sourceRoot":"","sources":["../../../src/core/operators/with-initial-value.mts"],"names":[],"mappings":"AAGA,OAAO,EAIL,KAAK,wBAAwB,EAE9B,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,eAAO,MAAM,gBAAgB,GAC1B,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC,KAAG,wBAAwB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAEO,CAAC"}

package/dist/core/operators/with-initial-value.mjs

@@ -14,15 +14,37 @@ import '../utils/id-maker.mjs';
  *
  * @example
  * ```ts
+ * //  Timeline:
+ * //
+ * //  num$             1    2    3
+ * //  withInitial$ 0   1    2    3
+ * //               ^
+ * //               initial value
+ * //
+ * //  Explanation:
+ * //  - withInitialValue provides an initial value before the source emits
+ * //  - Converts an uninitialized observable to an initialized one
+ * //  - Useful when you need a default value immediately
+ *
  * const num$ = source<number>();
  *
  * const initialized$ = num$.pipe(withInitialValue(0));
  *
+ * const mut_history: number[] = [];
+ *
  * initialized$.subscribe((x) => {
- *   console.log(x);
- * }); // immediately logs: 0
+ *   mut_history.push(x);
+ * });
+ *
+ * assert.deepStrictEqual(mut_history, [0]);
  *
  * num$.next(1); // logs: 1
+ *
+ * assert.deepStrictEqual(mut_history, [0, 1]);
+ *
+ * num$.next(2); // logs: 2
+ *
+ * assert.deepStrictEqual(mut_history, [0, 1, 2]);
  * ```
  */
 const withInitialValue = (initialValue) => (parentObservable) => new WithInitialValueObservableClass(parentObservable, initialValue);

package/dist/core/operators/with-initial-value.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"with-initial-value.mjs","sources":["../../../src/core/operators/with-initial-value.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAWA;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,MAAM,gBAAgB,GAC3B,CAAW,YAAe,KAC1B,CAAC,gBAAgB,KACf,IAAI,+BAA+B,CAAC,gBAAgB,EAAE,YAAY;AAEtE,MAAM,+BACJ,SAAQ,mCAAwD,CAAA;IAGhE,WAAA,CAAY,gBAA+B,EAAE,YAAe,EAAA;AAC1D,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;AAC3B,YAAA,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC;AAC1C,SAAA,CAAC;;AAGK,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;;QAGT,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC;;AAExC;;;;"}
+{"version":3,"file":"with-initial-value.mjs","sources":["../../../src/core/operators/with-initial-value.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAWA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CG;AACI,MAAM,gBAAgB,GAC3B,CAAW,YAAe,KAC1B,CAAC,gBAAgB,KACf,IAAI,+BAA+B,CAAC,gBAAgB,EAAE,YAAY;AAEtE,MAAM,+BACJ,SAAQ,mCAAwD,CAAA;IAGhE,WAAA,CAAY,gBAA+B,EAAE,YAAe,EAAA;AAC1D,QAAA,KAAK,CAAC;YACJ,OAAO,EAAE,CAAC,gBAAgB,CAAC;AAC3B,YAAA,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC;AAC1C,SAAA,CAAC;;AAGK,IAAA,SAAS,CAAC,aAA4B,EAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAE3B,QAAA,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE;AAE5B,QAAA,IAAI,GAAG,CAAC,aAAa,KAAK,aAAa,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;AAC9D,YAAA,OAAO;;QAGT,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC;;AAExC;;;;"}

package/dist/core/predefined/index.d.mts

@@ -0,0 +1,2 @@
+export * from './operators/index.mjs';
+//# sourceMappingURL=index.d.mts.map

package/dist/core/predefined/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/core/predefined/index.mts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}