Skip to content

Commit

Permalink
Bump version to v1.0.5: README refinements
Browse files Browse the repository at this point in the history
  • Loading branch information
ori88c committed Jun 29, 2024
1 parent bf8b9b8 commit 6530d4f
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ npm i zero-backpressure-semaphore-typescript

## Key Features

- __Backpressure Control__: Ideal for job workers and background services. Concurrency control alone isn't sufficient to ensure stability and performance if backpressure control is overlooked.
- __Graceful Termination__: Achieved via the `waitTillAllExecutingJobsAreSettled` method.
- __High Efficiency__: All state-altering operations have a constant time complexity, O(1).
- __Comprehensive documentation__: The class is thoroughly documented, enabling IDEs to provide helpful tooltips that enhance the coding experience.
- Fully covered by unit tests.
- Self-explanatory method names.
- No external runtime dependencies: Only development dependencies are used.
- ES2020 Compatibility.
- TypeScript support.
- Backpressure control.
- Graceful termination via method `waitTillAllExecutingJobsAreSettled`.
- Self-explanatory method names and comprehensive documentation.
- High efficiency: All state-altering operations have a constant time complexity, O(1).
- No external runtime dependencies: Only development dependencies are used.

## 1st use-case: Multiple Jobs Execution

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "zero-backpressure-semaphore-typescript",
"version": "1.0.4",
"version": "1.0.5",
"description": "A classic semaphore with modern API, inspired by the RAII idiom, offering backpressure control for enhanced efficiency",
"repository": {
"type": "git",
Expand Down

0 comments on commit 6530d4f

Please sign in to comment.