Releases: ori88c/zero-backpressure-semaphore-typescript
Releases · ori88c/zero-backpressure-semaphore-typescript
README and Docs improvements
Key Features
- README and Docs improvements.
README and Docs improvements
Key Features
- README and Docs improvements.
README and Docs improvements
Key Features
- README refinements.
- Improved docs for method
waitForAvailability
. - Slight refactor: replacing null with undefined, on available slots.
Target compatibility has been upgraded from ES6 to ES2020
Key Features
- Target compatibility has been upgraded from ES6 to ES2020. This change was made to leverage the widespread adoption of ES2020, its native support for async/await, and the use of Promise.allSettled within the semaphore.
Terminology update, and refined comments in tests.
Key Features
- Terminology: The 'rooms' terminology was replaced with 'slots', which is more common.
- Tests: A few comments were improved, for enhanced readability.
README and Docs improvements
Key Features
- README improvements: Clarifying that
waitForAvailability
is optional, and demonstrating how the same effect can be achieved viastartExecution
alone. - Enhancing a few method docs.
Renaming method waitTillAllExecutingJobsAreSettled to waitForAllExecutingJobsToComplete for improved readability
Key Features
- The only breaking change in this release is the renaming of method
waitTillAllExecutingJobsAreSettled
towaitForAllExecutingJobsToComplete
for improved readability. - README improvements.
Introducing a new method: waitForAvailability
Key Features
- Adding a new method
waitForAvailability
. Please note, this method is not commonly required. However under some cases, it may be a useful preliminary action beforestartExecution
. Especially whenever there's a motive thatstartExecution
will start immediately, for example due to working with a message-queue that has a tight timeout constraint.
README enhancements
Key Features
- README enhancements:
- Clarifying the space complexity implications of no backpressure control.
- Adding a message queue example.
Adding unit test that verifies correctness of the room-acquire mechanism
Key Features
- Added a unit test to verify the correctness of the room-acquire mechanism. This mechanism was previously covered indirectly by existing tests, but now receives direct attention.