@jscutlery/operators 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.0.2](https://github.com/jscutlery/devkit/compare/operators-1.0.1...operators-1.0.2) (2023-04-18)
+
+
+
+## [1.0.1](https://github.com/jscutlery/devkit/compare/operators-1.0.0...operators-1.0.1) (2023-04-18)
+
+
+
 # [1.0.0](https://github.com/jscutlery/devkit/compare/operators-0.2.1...operators-1.0.0) (2023-04-18)
 
 

package/index.cjs

@@ -1076,14 +1076,9 @@ $({ target: 'Object', stat: true, arity: 2, forced: Object.assign !== assign },
   assign: assign
 });
 
-/**
- * @description creates a derivated state from the source observable.
- *
- * @example source$.pipe(suspensify())
- *
- * @returns Observable<Suspense<T>>
- */
-function suspensify() {
+function suspensify(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+options) {
   return source$ => {
     return source$.pipe(_suspensify(), _coalesceFirstEmittedValue());
   };

package/index.js

@@ -1072,14 +1072,9 @@ $({ target: 'Object', stat: true, arity: 2, forced: Object.assign !== assign },
   assign: assign
 });
 
-/**
- * @description creates a derivated state from the source observable.
- *
- * @example source$.pipe(suspensify())
- *
- * @returns Observable<Suspense<T>>
- */
-function suspensify() {
+function suspensify(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+options) {
   return source$ => {
     return source$.pipe(_suspensify(), _coalesceFirstEmittedValue());
   };

package/package.json

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

package/src/lib/suspensify.d.ts

@@ -1,15 +1,51 @@
 import { OperatorFunction } from 'rxjs';
-export interface Suspense<T> {
+export interface SuspenseLax<T> {
     value: undefined | T;
     error: undefined | any;
     finalized: boolean;
     pending: boolean;
 }
+export interface SuspensePending {
+    finalized: false;
+    hasError: false;
+    hasValue: false;
+    pending: true;
+}
+export interface SuspenseWithValue<T> {
+    finalized: boolean;
+    hasError: false;
+    hasValue: true;
+    pending: false;
+    value: T;
+}
+export interface SuspenseWithError {
+    finalized: true;
+    hasError: true;
+    hasValue: false;
+    pending: false;
+    error: unknown;
+}
+export declare type SuspenseStrict<T> = SuspensePending | SuspenseWithValue<T> | SuspenseWithError;
+/**
+ * @todo 3.0.0: Make `Suspense` an alias for `SuspenseStrict`.
+ */
+export declare type Suspense<T> = SuspenseLax<T>;
+export interface SuspensifyOptions {
+    /**
+     * @deprecated 🚧 Work in progress.
+     */
+    strict?: boolean;
+}
 /**
  * @description creates a derivated state from the source observable.
  *
  * @example source$.pipe(suspensify())
  *
- * @returns Observable<Suspense<T>>
+ * @returns Observable<SuspenseLax<T> | SuspenseStrict<T>>
  */
-export declare function suspensify<T>(): OperatorFunction<T, Suspense<T>>;
+export declare function suspensify<T>(options?: {
+    strict: false;
+}): OperatorFunction<T, SuspenseLax<T>>;
+export declare function suspensify<T>(options: {
+    strict: true;
+}): OperatorFunction<T, SuspenseStrict<T>>;