watchable-promise 1.0.0 → 2.0.1

package/README.md

@@ -1,6 +1,6 @@
 # watchable-promise
 
-A Promise whose status you can read
+A Promise whose state and value you can read
 
 ## Installation
 
@@ -13,12 +13,20 @@ npm install watchable-promise
 - Directly create a `WatchablePromise` instance:
 
     ```javascript
-    import WatchablePromise from 'watchable-promise';
+    import WatchablePromise from "watchable-promise";
 
-    const p = new WatchablePromise(…);
+    const p = new WatchablePromise(resolve => setTimeout(() => resolve("foo"), 100));
 
-    console.log(p.status); // pending
+    console.log(p.state); // pending
     console.log(p.settled); // false
+    console.log(p.value); // undefined
+
+    const val = await p;
+
+    console.log(val) // "foo"
+    console.log(p.state); // fulfilled
+    console.log(p.settled); // true
+    console.log(p.value); // "foo"
     ```
 
 - Using an existing `Promise` instance:
@@ -26,17 +34,19 @@ npm install watchable-promise
     ```javascript
     import WatchablePromise from 'watchable-promise';
 
-    const existingPromise = new Promise(resolve => setTimeout(() => resolve('foo'), 100));
+    const existingPromise = new Promise(resolve => setTimeout(() => resolve("foo"), 100));
     const p = WatchablePromise.from(existingPromise);
 
-    console.log(p.status); // pending
+    console.log(p.state); // pending
     console.log(p.settled); // false
+    console.log(p.value); // undefined
+
+    const val = await p;
 
-    p.then(val => {
-        console.log(val) // 'bar'
-        console.log(p.status); // fulfilled
-        console.log(p.settled); // true
-    });
+    console.log(val) // "foo"
+    console.log(p.state); // fulfilled
+    console.log(p.settled); // true
+    console.log(p.value); // "foo"
     ```
 
 - Using `WatchablePromise.withResolvers()`:
@@ -46,16 +56,15 @@ npm install watchable-promise
     
     const { promise, resolve, reject } = WatchablePromise.withResolvers();
 
-    console.log(promise.status); // pending
+    console.log(promise.state); // pending
     console.log(promise.settled); // false
+    console.log(promise.value); // undefined
     
-    resolve('bar');
+    await resolve("foo");
 
-    promise.then(val => {
-        console.log(val) // 'bar'
-        console.log(promise.status); // fulfilled
-        console.log(promise.settled); // true
-    });
+    console.log(promise.state); // fulfilled
+    console.log(promise.settled); // true
+    console.log(promise.value); // "foo"
     ```
 
 ## License

package/dist/index.d.ts

@@ -2,7 +2,8 @@ declare class WatchablePromise<T> extends Promise<T> {
     #private;
     constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void);
     get settled(): boolean;
-    get status(): "pending" | "fulfilled" | "rejected";
+    get state(): "pending" | "fulfilled" | "rejected";
+    get value(): any;
     static from<T>(existingPromise: Promise<T>): WatchablePromise<T>;
     static withResolvers<T>(): {
         promise: WatchablePromise<T>;

package/dist/index.js

@@ -1,7 +1,8 @@
 // src/index.ts
 var WatchablePromise = class _WatchablePromise extends Promise {
   #settled = false;
-  #status = "pending";
+  #state = "pending";
+  #value;
   constructor(executor) {
     let resolve;
     let reject;
@@ -10,12 +11,14 @@ var WatchablePromise = class _WatchablePromise extends Promise {
       reject = rej;
     });
     this.then(
-      () => {
-        this.#status = "fulfilled";
+      (value) => {
+        this.#state = "fulfilled";
+        this.#value = value;
         this.#settled = true;
       },
-      () => {
-        this.#status = "rejected";
+      (reason) => {
+        this.#state = "rejected";
+        this.#value = reason;
         this.#settled = true;
       }
     );
@@ -24,8 +27,11 @@ var WatchablePromise = class _WatchablePromise extends Promise {
   get settled() {
     return this.#settled;
   }
-  get status() {
-    return this.#status;
+  get state() {
+    return this.#state;
+  }
+  get value() {
+    return this.#value;
   }
   static from(existingPromise) {
     return new _WatchablePromise((resolve, reject) => {

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "sourcesContent": ["class WatchablePromise<T> extends Promise<T> {\n  #settled = false;\n  #status: \"pending\" | \"fulfilled\" | \"rejected\" = \"pending\";\n\n  constructor(\n    executor: (\n      resolve: (value: T | PromiseLike<T>) => void,\n      reject: (reason?: any) => void,\n    ) => void,\n  ) {\n    let resolve: (value: T | PromiseLike<T>) => void;\n    let reject: (reason?: any) => void;\n\n    super((res, rej) => {\n      resolve = res;\n      reject = rej;\n    });\n\n    this.then(\n      () => {\n        this.#status = \"fulfilled\";\n        this.#settled = true;\n      },\n      () => {\n        this.#status = \"rejected\";\n        this.#settled = true;\n      },\n    );\n\n    // @ts-ignore\n    executor(resolve, reject);\n  }\n\n  get settled() {\n    return this.#settled;\n  }\n\n  get status() {\n    return this.#status;\n  }\n\n  static from<T>(existingPromise: Promise<T>): WatchablePromise<T> {\n    return new WatchablePromise<T>((resolve, reject) => {\n      existingPromise.then(resolve, reject);\n    });\n  }\n\n  static withResolvers<T>() {\n    let resolve: (value: T | PromiseLike<T>) => void;\n    let reject: (reason?: any) => void;\n    const promise = new WatchablePromise<T>((res, rej) => {\n      resolve = res;\n      reject = rej;\n    });\n    // @ts-ignore\n    return { promise, resolve, reject };\n  }\n\n  static get [Symbol.species]() {\n    return Promise;\n  }\n\n  get [Symbol.toStringTag]() {\n    return \"WatchablePromise\";\n  }\n}\n\nexport default WatchablePromise;\n"],
-  "mappings": ";AAAA,IAAM,mBAAN,MAAM,0BAA4B,QAAW;AAAA,EAC3C,WAAW;AAAA,EACX,UAAgD;AAAA,EAEhD,YACE,UAIA;AACA,QAAI;AACJ,QAAI;AAEJ,UAAM,CAAC,KAAK,QAAQ;AAClB,gBAAU;AACV,eAAS;AAAA,IACX,CAAC;AAED,SAAK;AAAA,MACH,MAAM;AACJ,aAAK,UAAU;AACf,aAAK,WAAW;AAAA,MAClB;AAAA,MACA,MAAM;AACJ,aAAK,UAAU;AACf,aAAK,WAAW;AAAA,MAClB;AAAA,IACF;AAGA,aAAS,SAAS,MAAM;AAAA,EAC1B;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAO,KAAQ,iBAAkD;AAC/D,WAAO,IAAI,kBAAoB,CAAC,SAAS,WAAW;AAClD,sBAAgB,KAAK,SAAS,MAAM;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,OAAO,gBAAmB;AACxB,QAAI;AACJ,QAAI;AACJ,UAAM,UAAU,IAAI,kBAAoB,CAAC,KAAK,QAAQ;AACpD,gBAAU;AACV,eAAS;AAAA,IACX,CAAC;AAED,WAAO,EAAE,SAAS,SAAS,OAAO;AAAA,EACpC;AAAA,EAEA,YAAY,OAAO,OAAO,IAAI;AAC5B,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,OAAO,WAAW,IAAI;AACzB,WAAO;AAAA,EACT;AACF;AAEA,IAAO,gBAAQ;",
+  "sourcesContent": ["class WatchablePromise<T> extends Promise<T> {\n  #settled = false;\n  #state: \"pending\" | \"fulfilled\" | \"rejected\" = \"pending\";\n  #value: T | any;\n\n  constructor(\n    executor: (\n      resolve: (value: T | PromiseLike<T>) => void,\n      reject: (reason?: any) => void,\n    ) => void,\n  ) {\n    let resolve: (value: T | PromiseLike<T>) => void;\n    let reject: (reason?: any) => void;\n\n    super((res, rej) => {\n      resolve = res;\n      reject = rej;\n    });\n\n    this.then(\n      (value) => {\n        this.#state = \"fulfilled\";\n        this.#value = value;\n        this.#settled = true;\n      },\n      (reason) => {\n        this.#state = \"rejected\";\n        this.#value = reason;\n        this.#settled = true;\n      },\n    );\n\n    // @ts-ignore\n    executor(resolve, reject);\n  }\n\n  get settled() {\n    return this.#settled;\n  }\n\n  get state() {\n    return this.#state;\n  }\n\n  get value() {\n    return this.#value;\n  }\n\n  static from<T>(existingPromise: Promise<T>): WatchablePromise<T> {\n    return new WatchablePromise<T>((resolve, reject) => {\n      existingPromise.then(resolve, reject);\n    });\n  }\n\n  static withResolvers<T>() {\n    let resolve: (value: T | PromiseLike<T>) => void;\n    let reject: (reason?: any) => void;\n    const promise = new WatchablePromise<T>((res, rej) => {\n      resolve = res;\n      reject = rej;\n    });\n    // @ts-ignore\n    return { promise, resolve, reject };\n  }\n\n  static get [Symbol.species]() {\n    return Promise;\n  }\n\n  get [Symbol.toStringTag]() {\n    return \"WatchablePromise\";\n  }\n}\n\nexport default WatchablePromise;\n"],
+  "mappings": ";AAAA,IAAM,mBAAN,MAAM,0BAA4B,QAAW;AAAA,EAC3C,WAAW;AAAA,EACX,SAA+C;AAAA,EAC/C;AAAA,EAEA,YACE,UAIA;AACA,QAAI;AACJ,QAAI;AAEJ,UAAM,CAAC,KAAK,QAAQ;AAClB,gBAAU;AACV,eAAS;AAAA,IACX,CAAC;AAED,SAAK;AAAA,MACH,CAAC,UAAU;AACT,aAAK,SAAS;AACd,aAAK,SAAS;AACd,aAAK,WAAW;AAAA,MAClB;AAAA,MACA,CAAC,WAAW;AACV,aAAK,SAAS;AACd,aAAK,SAAS;AACd,aAAK,WAAW;AAAA,MAClB;AAAA,IACF;AAGA,aAAS,SAAS,MAAM;AAAA,EAC1B;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAO,KAAQ,iBAAkD;AAC/D,WAAO,IAAI,kBAAoB,CAAC,SAAS,WAAW;AAClD,sBAAgB,KAAK,SAAS,MAAM;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,OAAO,gBAAmB;AACxB,QAAI;AACJ,QAAI;AACJ,UAAM,UAAU,IAAI,kBAAoB,CAAC,KAAK,QAAQ;AACpD,gBAAU;AACV,eAAS;AAAA,IACX,CAAC;AAED,WAAO,EAAE,SAAS,SAAS,OAAO;AAAA,EACpC;AAAA,EAEA,YAAY,OAAO,OAAO,IAAI;AAC5B,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,OAAO,WAAW,IAAI;AACzB,WAAO;AAAA,EACT;AACF;AAEA,IAAO,gBAAQ;",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "watchable-promise",
-  "version": "1.0.0",
-  "description": "A Promise whose status you can read",
+  "version": "2.0.1",
+  "description": "A Promise whose state and value you can read",
   "type": "module",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,8 +18,7 @@
     "start": "echo 'There is nothing to start. I think you may just want to run the tests instead' && exit 1",
     "test": "vitest",
     "test-once": "vitest run",
-    "prepack": "npm run require-pristine-tree && npm run test-once",
-    "prepublish": "npm run build",
+    "prepack": "npm run require-pristine-tree && npm run test-once && npm run build",
     "preversion": "npm run require-pristine-tree && npm run test-once",
     "prepare": "husky install",
     "require-pristine-tree": "exit $(git status --porcelain | wc -l)"
@@ -30,7 +29,7 @@
   },
   "keywords": [
     "promises",
-    "status",
+    "state",
     "watchable"
   ],
   "author": {