acquireLockStep - Medusa Core Workflows Reference

This documentation provides a reference to the acquireLockStep. It belongs to the @medusajs/medusa/core-flows package.

This step acquires a lock for a given key. Learn more about locks in the Locking Module guide.

Example#

Code
1const data = acquireLockStep({2  "key": "my-lock-key",3  "ttl": 604})

Input#

AcquireLockStepInputAcquireLockStepInput

The keys to be locked

keystring | string[]

The keys to be locked

timeoutnumberOptional

The maximum time to wait for acquiring the lock. If the lock cannot be acquired within this time, an error is thrown.

Default: 0

retryIntervalnumberOptional

The time (in seconds) to wait between each retry to acquire the lock.

Default: 0.3

ttlnumberOptional

The expiration time (in seconds) for the lock. If the lock is already acquired and the owner is the same, the expiration time is extended by the value passed. If not specified, the lock does not expire.

ownerIdstringOptional

The owner ID for the lock. If specified, only the owner can release the lock or extend its expiration time.

providerstringOptional

The provider name to use for locking. If no provider is passed, the default provider (in-memory or the provider configured in medusa-config.ts) will be used.

skipOnSubWorkflowbooleanOptional