watchable-promise 1.0.0 → 2.0.0

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "watchable-promise",
-  "version": "1.0.0",
-  "description": "A Promise whose status you can read",
+  "version": "2.0.0",
+  "description": "A Promise whose state and value you can read",
   "type": "module",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,7 +30,7 @@
   },
   "keywords": [
     "promises",
-    "status",
+    "state",
     "watchable"
   ],
   "author": {