Skip to content

Commit 3c5c243

Browse files
committed
Bump version to v3.0.8: Refine README to include the weighted variant reference and a metrics example
1 parent a9da152 commit 3c5c243

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The design addresses the two primary semaphore use cases in Node.js:
1111

1212
Each use case necessitates distinct handling capabilities, which will be discussed separately with accompanying examples.
1313

14+
If your use case involves weighted jobs — where instead of limiting the maximum concurrency, you need to enforce a maximum total weight for concurrently executing jobs — consider using the weighted variant of this package: [zero-backpressure-weighted-promise-semaphore](https://www.npmjs.com/package/zero-backpressure-weighted-promise-semaphore).
15+
1416
## Table of Contents
1517

1618
* [Key Features](#key-features)
@@ -35,7 +37,7 @@ Each use case necessitates distinct handling capabilities, which will be discuss
3537
- __High Efficiency :gear:__: All state-altering operations have a constant time complexity, O(1).
3638
- __Comprehensive documentation :books:__: The class is thoroughly documented, enabling IDEs to provide helpful tooltips that enhance the coding experience.
3739
- __Robust Error Handling__: Uncaught errors from background jobs triggered by `startExecution` are captured and can be accessed using the `extractUncaughtErrors` method.
38-
- __Metrics :bar_chart:__: The class offers various metrics through getter methods, providing insights into the semaphore's current state.
40+
- __Metrics :bar_chart:__: The class offers various metrics through getter methods, such as `amountOfCurrentlyExecutingJobs`, providing insights into the semaphore's current state. These metrics can be used for periodic logging or to collect statistics from real-world usage.
3941
- __Tests :test_tube:__: Fully covered by rigorous unit tests.
4042
- Self-explanatory method names.
4143
- No external runtime dependencies: Only development dependencies are used.

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "zero-backpressure-semaphore-typescript",
3-
"version": "3.0.7",
3+
"version": "3.0.8",
44
"description": "A modern Promise-semaphore for Node.js projects, enabling users to limit the number of concurrently executing promises. Offering backpressure control for enhanced efficiency, utilizing a communicative API that signals availability, promoting a just-in-time approach. Additionally, it incorporates mechanisms for graceful termination and error handling, making it suitable for complex scenarios.",
55
"repository": {
66
"type": "git",

0 commit comments

Comments
 (0)