feat(minor): improve documentation

giladgd · Feb 3, 2024 · 481cfa0 · 481cfa0
1 parent a657592
commit 481cfa0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -26,7 +26,7 @@ jobs:
           node-version: "18"
       - name: Install modules
         run: npm ci
-      - name: Run vite tests
+      - name: Run vitest tests
         run: npm run test:vitest -- --coverage --reporter=junit
       - name: Upload coverage
         uses: codecov/codecov-action@v2

diff --git a/README.md b/README.md
@@ -77,6 +77,18 @@ console.log("lock acquired");
 activeLock.dispose();
 ```
 
+### `waitForLockRelease`
+Wait for a lock to be released for a given `scope` and `key`.
+
+```typescript
+import {waitForLockRelease} from "lifecycle-utils";
+
+const scope = {}; // can be a reference to any object you like
+
+await waitForLockRelease(scope, "myKey");
+console.log("lock is released");
+```
+
 ### `EventRelay`
 A simple event relay.