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.

Sign up for GitHub

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

[core-amqp] improve doc comment for AcquireLockProperties.abortSignal #15417

Merged
merged 1 commit into from
Jun 4, 2021
Merged

[core-amqp] improve doc comment for AcquireLockProperties.abortSignal #15417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 sdk/core/core-amqp/src/util/lock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import { logger } from "../log";
export interface AcquireLockProperties {
/**
* An implementation of the `AbortSignalLike` interface to signal the request to cancel lock acquisition.
* This only applies to the acquisition of a lock. Once the lock is acquired, the task is invoked and `acquire`
* can no longer be cancelled.
* This does not cancel running the task passed to `acquire()` if the lock has been acquired,
* but will prevent it from running if cancelled before the task is invoked.
*/
Expand Down