method

RiduClient.acquireDocumentLock

Acquire or renew a document lock, optionally taking over an eligible lease.

Arguments

Argument	Type	Description
`collection`	`Slug`	The collection value.
`id`	`string`	The id value.
`takeover`	`boolean \| undefined`	The takeover value.
`options`	`RequestOptions \| undefined`	The options value.

Returns

The declared result.

Promise<DocumentLockEnvelope>

Full signature

RiduClient.acquireDocumentLock<Slug extends CollectionSlug<Config>>(
	collection: Slug,
	id: string,
	takeover?: boolean,
	options?: RequestOptions,
): Promise<DocumentLockEnvelope>

Source packages/sdk/src/types.ts:1016

Related types

CollectionSlug
The generated union of collection slugs.
RequestOptions
Options shared by every request.
DocumentLockEnvelope
The current lease and whether this request owns or acquired it.