superlock 1.4.4 → 1.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -8
- package/package.json +9 -3
package/README.md
CHANGED
|
@@ -1,8 +1,19 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://superlock.js.org/">
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/wordmark.svg">
|
|
5
|
+
<img alt="superlock" src="docs/anatomy/wordmark-light.svg" width="640">
|
|
6
|
+
</picture>
|
|
7
|
+
</a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
<p align="center" class="subtitle">The minimal Node.js concurrency toolkit.</p>
|
|
11
|
+
|
|
12
|
+
<p align="center" class="badges">
|
|
13
|
+
<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>
|
|
14
|
+
<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>
|
|
15
|
+
<a href="https://www.npmjs.com/package/superlock"><img alt="NPM Status" src="https://img.shields.io/npm/dm/superlock?style=flat-square"></a>
|
|
16
|
+
</p>
|
|
6
17
|
|
|
7
18
|
## Why
|
|
8
19
|
|
|
@@ -26,7 +37,7 @@ $ npm install superlock --save
|
|
|
26
37
|
|
|
27
38
|
The lock is a mutex by default: one caller holds it, the rest wait in arrival order.
|
|
28
39
|
|
|
29
|
-
<a href="https://
|
|
40
|
+
<a href="https://superlock.js.org/#/?id=as-mutex">
|
|
30
41
|
<picture>
|
|
31
42
|
<source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/mutex.svg">
|
|
32
43
|
<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)
|
|
|
55
66
|
|
|
56
67
|
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:
|
|
57
68
|
|
|
58
|
-
<a href="https://
|
|
69
|
+
<a href="https://superlock.js.org/#/?id=as-semaphore">
|
|
59
70
|
<picture>
|
|
60
71
|
<source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/semaphore.svg">
|
|
61
72
|
<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)
|
|
|
86
97
|
|
|
87
98
|
`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.
|
|
88
99
|
|
|
89
|
-
<a href="https://
|
|
100
|
+
<a href="https://superlock.js.org/#/?id=as-fair-queue">
|
|
90
101
|
<picture>
|
|
91
102
|
<source media="(prefers-color-scheme: dark)" srcset="docs/anatomy/fair-queue.svg">
|
|
92
103
|
<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
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "superlock",
|
|
3
|
-
"description": "
|
|
4
|
-
"homepage": "https://
|
|
5
|
-
"version": "1.4.
|
|
3
|
+
"description": "The minimal Node.js concurrency toolkit: mutex, semaphore and fair queue for async/await, with no dependencies.",
|
|
4
|
+
"homepage": "https://superlock.js.org/",
|
|
5
|
+
"version": "1.4.5",
|
|
6
6
|
"types": "src/index.d.ts",
|
|
7
7
|
"main": "src/index.js",
|
|
8
8
|
"exports": {
|
|
@@ -73,6 +73,7 @@
|
|
|
73
73
|
"dev": "concurrently \"gulp\" \"npm run dev:server\"",
|
|
74
74
|
"dev:server": "browser-sync start --server --files \"index.html, README.md, static/**/*.(css|js)\"",
|
|
75
75
|
"lint": "standard",
|
|
76
|
+
"og": "node docs/og/build.mjs",
|
|
76
77
|
"postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
|
|
77
78
|
"prerelease": "npm run contributors",
|
|
78
79
|
"pretest": "npm run lint",
|
|
@@ -88,6 +89,11 @@
|
|
|
88
89
|
"!test/helpers.js"
|
|
89
90
|
]
|
|
90
91
|
},
|
|
92
|
+
"c8": {
|
|
93
|
+
"include": [
|
|
94
|
+
"src/**/*.js"
|
|
95
|
+
]
|
|
96
|
+
},
|
|
91
97
|
"commitlint": {
|
|
92
98
|
"extends": [
|
|
93
99
|
"@commitlint/config-conventional"
|