method

RiduClient.acquireDocumentLock

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

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

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

@param collection: The collection value.
@param id: The id value.
@param takeover: The takeover value.
@param options: The options value.
@returns: The declared result.

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.