Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: clarify signal aborted behavior #308

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ await redlock.using([senderId, recipientId], 5000, async (signal) => {

// Make sure any attempted lock extension has not failed.
if (signal.aborted) {
// Note: The error thrown out of `redlock.using` will not be `signal.error` but rather "The operation was unable to achieve a quorum during its retry window."
// and that's after retrying to release the lock (after 2-3 seconds if you use the default settings).
throw signal.error;
}

Expand Down