method

RiduClient.documentLock

Read the current document-lock lease.

Arguments

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

Returns

The declared result.

Promise<DocumentLockEnvelope>

Full signature

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

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

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.