You're viewing archived documentation for @imqueue/rpc v1.17.1. APIs may differ from the current release. View the latest version ↗

IMQLock.acquire() method

Acquires a lock for a given key

Signature:

static acquire<T>(key: string, callback?: (...args: any[]) => any, metadata?: IMQLockMetadataItem): Promise<AcquiredLock<T>>;

Parameters

Parameter

Type

Description

key

string

callback

(...args: any[]) => any

(Optional)

metadata

IMQLockMetadataItem

(Optional)

Returns:

Promise<AcquiredLock<T>>

{AcquiredLock}