add isCanceled method

alkemics · Apr 28, 2020 · fad1157 · fad1157
1 parent 1987549
commit fad1157
Show file tree

Hide file tree

Showing 10 changed files with 503 additions and 6,179 deletions.
diff --git a/.github/workflows/cypress.yml b/.github/workflows/cypress.yml
@@ -10,10 +10,8 @@ jobs:
   cypress-run:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v1
-      - name: Cypress run
-        uses: cypress-io/github-action@v1
+      - uses: actions/checkout@v2
+      - uses: cypress-io/github-action@v1
         with:
           browser: chrome
           headless: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,9 @@
-## 3.0.0 (2020-04-07)
+## [3.1.0](https://github.com/alkemics/CancelablePromise/releases/tag/v3.1.0) (2020-04-28)
+
+- upgrade dev dependencies
+- add `isCanceled` method to cancelable promises
+
+## [3.0.0](https://github.com/alkemics/CancelablePromise/releases/tag/v3.0.0) (2020-04-07)
 
 - Complete rewrite of `CancelablePromise`.
   Now promises returned from `Promise` API such as `then` or `catch` can cancel the root promise and all promises created from this root promise:

diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ FYI, you can cancel a fetch request with AbortController & AbortSignal.
 - [API](#api)
   - [cancelable](#cancelable)
   - [CancelablePromise](#cancelablepromise)
+  - [CancelablePromise.cancel](#cancelablepromisecancel)
+  - [CancelablePromise.isCanceled](#cancelablepromiseiscanceled)
   - [Static methods](#static-methods)
 - [Scripts](#scripts)
   - [Build](#build)
@@ -112,6 +114,24 @@ new CancelablePromise((resolve, reject) => {
 });
 ```
 
+### CancelablePromise.cancel
+
+```javascript
+/**
+ * @returns {void}
+ */
+cancelablePromise.cancel();
+```
+
+### CancelablePromise.isCanceled
+
+```javascript
+/**
+ * @returns {boolean}
+ */
+cancelablePromise.isCanceled();
+```
+
 ### Static methods
 
 Same as Promise static methods.

diff --git a/cypress/integration/spec.js b/cypress/integration/spec.js
@@ -34,7 +34,9 @@ describe('cancelable promise', () => {
     const promise = new CancelablePromise((resolve) => {
       resolve(42);
     }).then(stub);
+    expect(promise.isCanceled()).to.be.false;
     promise.cancel();
+    expect(promise.isCanceled()).to.be.true;
     cy.wait(1).then(() => {
       expect(stub).not.to.be.called;
     });
@@ -45,7 +47,9 @@ describe('cancelable promise', () => {
     const promise = new CancelablePromise((resolve, reject) => {
       reject(42);
     }).catch(stub);
+    expect(promise.isCanceled()).to.be.false;
     promise.cancel();
+    expect(promise.isCanceled()).to.be.true;
     cy.wait(1).then(() => {
       expect(stub).not.to.be.called;
     });