@jscutlery/operators 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [2.1.0](https://github.com/jscutlery/devkit/compare/operators-2.0.1...operators-2.1.0) (2023-04-27)
+
+
+### Features
+
+* **operators:** ✨ expose pending state constant ([caaea8e](https://github.com/jscutlery/devkit/commit/caaea8e3144aca71ecf75830777bcadd2ba23c37))
+
+
+
 ## [2.0.1](https://github.com/jscutlery/devkit/compare/operators-2.0.0...operators-2.0.1) (2023-04-27)
 
 

package/index.cjs

@@ -1089,7 +1089,18 @@ function suspensify({
     );
   };
 }
-
+/**
+ * This is the initial state of the Suspense.
+ * It is exposed for convenience and edge cases where the initial state must be set initially.
+ * e.g. when using {@link suspensify} on inner observables.
+ * @example toSignal(source$.pipe(switchMap(() => fetchData().pipe(suspensify()))), {initialValue: pending});
+ */
+const pending = {
+  finalized: false,
+  hasError: false,
+  hasValue: false,
+  pending: true
+};
 function _coalesceFirstEmittedValue() {
   return source$ => {
     return new rxjs.Observable(observer => {
@@ -1108,13 +1119,7 @@ const TRUE = true;
 const FALSE = false;
 function _suspensify() {
   return source$ => {
-    const initialState = {
-      finalized: false,
-      hasError: false,
-      hasValue: false,
-      pending: true
-    };
-    return source$.pipe(operators.materialize(), operators.scan((state = initialState, notification) => {
+    return source$.pipe(operators.materialize(), operators.scan((state, notification) => {
       switch (notification.kind) {
         /* Value. */
         case 'N':
@@ -1141,7 +1146,7 @@ function _suspensify() {
             pending: FALSE
           });
       }
-    }, initialState), operators.startWith(initialState));
+    }, pending), operators.startWith(pending));
   };
 }
 

package/index.js

@@ -1085,7 +1085,18 @@ function suspensify({
     );
   };
 }
-
+/**
+ * This is the initial state of the Suspense.
+ * It is exposed for convenience and edge cases where the initial state must be set initially.
+ * e.g. when using {@link suspensify} on inner observables.
+ * @example toSignal(source$.pipe(switchMap(() => fetchData().pipe(suspensify()))), {initialValue: pending});
+ */
+const pending = {
+  finalized: false,
+  hasError: false,
+  hasValue: false,
+  pending: true
+};
 function _coalesceFirstEmittedValue() {
   return source$ => {
     return new Observable(observer => {
@@ -1104,13 +1115,7 @@ const TRUE = true;
 const FALSE = false;
 function _suspensify() {
   return source$ => {
-    const initialState = {
-      finalized: false,
-      hasError: false,
-      hasValue: false,
-      pending: true
-    };
-    return source$.pipe(materialize(), scan((state = initialState, notification) => {
+    return source$.pipe(materialize(), scan((state, notification) => {
       switch (notification.kind) {
         /* Value. */
         case 'N':
@@ -1137,7 +1142,7 @@ function _suspensify() {
             pending: FALSE
           });
       }
-    }, initialState), startWith(initialState));
+    }, pending), startWith(pending));
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jscutlery/operators",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "repository": {
     "url": "https://github.com/jscutlery/devkit"
   },

package/src/lib/suspensify.d.ts

@@ -50,3 +50,10 @@ export declare function suspensify<T>(options: {
 export declare function suspensify<T>(options?: {
     strict: true;
 }): OperatorFunction<T, Suspense<T>>;
+/**
+ * This is the initial state of the Suspense.
+ * It is exposed for convenience and edge cases where the initial state must be set initially.
+ * e.g. when using {@link suspensify} on inner observables.
+ * @example toSignal(source$.pipe(switchMap(() => fetchData().pipe(suspensify()))), {initialValue: pending});
+ */
+export declare const pending: SuspensePending;

package/src/lib/testing/observer.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="jest" />
 import { Observable } from 'rxjs';
 export declare function createObserver(): {
     observe<T>(observable: Observable<T>): {