chore: improve readme (#8)

danielnakamashi · Sep 21, 2024 · 8105577 · 8105577
1 parent dad0dcb
commit 8105577
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,32 @@
 # abortable-promise
 
 Promises that can be aborted using AbortController
+
+```typescript
+const abortController = new AbortController()
+const promise = new AbortablePromise(
+  (resolve, reject) => {
+    setTimeout(() => {
+      resolve('success')
+    }, 200)
+    setTimeout(() => {
+      reject('error')
+    }, 300)
+  },
+  { signal: abortController.signal },
+)
+
+setTimeout(() => {
+  abortController.abort('aborted by the user')
+}, 100)
+
+promise
+  .then((result) => {
+    console.log(result)
+  })
+  .catch((error) => {
+    console.log(error)
+  })
+```
+
+It should log `aborted by the user`