releaseLockStep - Medusa Core Workflows Reference

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

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

Example#

Code
1const data = releaseLockStep({2  key: "my-lock-key"3})

Input#

ReleaseLockStepInputReleaseLockStepInput

The locked keys to be released

keystring | string[]

The keys to be released

ownerIdstringOptional

The ID of the lock's owner. The lock can be released either if it doesn't have an owner, or if its owner ID matches the one passed in this property.

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