superlock 1.4.4 → 1.4.6

package/README.md

@@ -1,8 +1,19 @@
-[![Last version](https://img.shields.io/github/v/tag/Kikobeats/superlock?style=flat-square)](https://github.com/Kikobeats/superlock/releases)
-[![Coverage Status](https://img.shields.io/coverallsCoverage/github/Kikobeats/superlock?style=flat-square)](https://coveralls.io/github/Kikobeats/superlock)
-[![NPM Status](https://img.shields.io/npm/dm/superlock?style=flat-square)](https://www.npmjs.com/package/superlock)
-
-> A mutex/semaphore implementation made easy to use.
+<p align="center">
+  <a href="https://superlock.js.org/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/wordmark.svg">
+      <img alt="superlock" src="docs/anatomy/wordmark-light.svg" width="640">
+    </picture>
+  </a>
+</p>
+
+<p align="center" class="subtitle">The minimal Node.js concurrency toolkit.</p>
+
+<p align="center" class="badges">
+  <a href="https://github.com/Kikobeats/superlock/releases"><img alt="Last version" src="https://img.shields.io/github/v/tag/Kikobeats/superlock?style=flat-square"></a>
+  <a href="https://coveralls.io/github/Kikobeats/superlock"><img alt="Coverage Status" src="https://img.shields.io/coverallsCoverage/github/Kikobeats/superlock?style=flat-square"></a>
+  <a href="https://www.npmjs.com/package/superlock"><img alt="NPM Status" src="https://img.shields.io/npm/dm/superlock?style=flat-square"></a>
+</p>
 
 ## Why
 
@@ -26,7 +37,7 @@ $ npm install superlock --save
 
 The lock is a mutex by default: one caller holds it, the rest wait in arrival order.
 
-<a href="https://kikobeats.github.io/superlock/#/?id=as-mutex">
+<a href="https://superlock.js.org/#/?id=as-mutex">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/mutex.svg">
     <img alt="A coin-feed escapement: tokens queue in a column, a pusher one token thick carries exactly one at a time to a press, and the next drops in only after release()." src="docs/anatomy/mutex-light.svg">
@@ -55,7 +66,7 @@ console.log(executions)
 
 Call `withLock(n)` with `n` as the maximum concurrency for the lock. Up to `n` callers hold it at once; a freed slot goes to the oldest waiter:
 
-<a href="https://kikobeats.github.io/superlock/#/?id=as-semaphore">
+<a href="https://superlock.js.org/#/?id=as-semaphore">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/semaphore.svg">
     <img alt="Twin lanes fed by one column: a diverter drops the oldest waiting token into whichever of two lanes is free, and each lane releases on its own." src="docs/anatomy/semaphore-light.svg">
@@ -86,7 +97,7 @@ console.log(executions)
 
 `withFairQueue` is [fair queuing](https://en.wikipedia.org/wiki/Fair_queuing): one queue per key, and a free slot rotates across those keys. The same key is still served in arrival order. Callers that omit the key share one queue.
 
-<a href="https://kikobeats.github.io/superlock/#/?id=as-fair-queue">
+<a href="https://superlock.js.org/#/?id=as-fair-queue">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/fair-queue.svg">
     <img alt="An indexing table: one column per key around a rotating dial that feeds one press, visiting the keys in turn so a deep column cannot starve the others." src="docs/anatomy/fair-queue-light.svg">

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "superlock",
-  "description": "Minimal async mutex and semaphore for serializing critical sections in Node.js.",
-  "homepage": "https://kikobeats.github.io/superlock/",
-  "version": "1.4.4",
+  "description": "The minimal Node.js concurrency toolkit: mutex, semaphore and fair queue for async/await, with no dependencies.",
+  "homepage": "https://superlock.js.org/",
+  "version": "1.4.6",
   "types": "src/index.d.ts",
   "main": "src/index.js",
   "exports": {
@@ -73,6 +73,7 @@
     "dev": "concurrently \"gulp\" \"npm run dev:server\"",
     "dev:server": "browser-sync start --server --files \"index.html, README.md, static/**/*.(css|js)\"",
     "lint": "standard",
+    "og": "node docs/og/build.mjs",
     "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
     "prerelease": "npm run contributors",
     "pretest": "npm run lint",
@@ -88,6 +89,16 @@
       "!test/helpers.js"
     ]
   },
+  "c8": {
+    "branches": 100,
+    "check-coverage": true,
+    "functions": 100,
+    "include": [
+      "src/**/*.js"
+    ],
+    "lines": 100,
+    "statements": 100
+  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"

package/src/create.js

@@ -11,18 +11,25 @@ module.exports = (slots = 1) => {
     if (waiter) return waiter.acquire()
   }
 
+  const ready = Promise.resolve(release)
+
   const acquire = resolve => {
     --slots
     resolve(release)
   }
 
-  const lock = signal =>
-    new Promise(resolve => {
+  const lock = signal => {
+    if (signal == null && slots !== 0) {
+      --slots
+      return ready
+    }
+
+    return new Promise(resolve => {
       if (signal != null && typeof signal.addEventListener !== 'function') {
         throw new TypeError('`signal` needs to be an AbortSignal.')
       }
-      if (signal?.aborted) return resolve(null)
-      if (!lock.isLocked()) return acquire(resolve)
+      if (signal != null && signal.aborted) return resolve(null)
+      if (slots !== 0) return acquire(resolve)
 
       const waiter = { acquire: () => acquire(resolve) }
       const node = queue.enqueue(waiter)
@@ -39,6 +46,7 @@ module.exports = (slots = 1) => {
         signal.addEventListener('abort', onAbort, { once: true })
       }
     })
+  }
 
   lock.isLocked = () => slots === 0