method

RiduClient.update

Update one document, optionally guarded by its revision.

Arguments

Argument	Type	Description
`collection`	`Slug`	The collection value.
`id`	`string`	The id value.
`data`	`DraftUpdateFor<Config, Slug>`	The data value.
`options`	`MutationOptions<LocaleFor<Config>> & { draft?: true; } & { draft: true; }`	The options value.

Returns

The declared result.

Promise<OutputFor<Config, Slug>>

Full signature (2 overloads)

RiduClient.update<Slug extends DraftCollectionSlug<Config>>(
	collection: Slug,
	id: string,
	data: DraftUpdateFor<Config, Slug>,
	options: UpdateOptions<LocaleFor<Config>, true> & { draft: true; },
): Promise<OutputFor<Config, Slug>>
RiduClient.update<Slug extends CollectionSlug<Config>>(
	collection: Slug,
	id: string,
	data: UpdateFor<Config, Slug>,
	options?: UpdateOptions<LocaleFor<Config>, CollectionDraftsFor<Config, Slug>>,
): Promise<OutputFor<Config, Slug>>

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

Related types

DraftCollectionSlug
Collection slugs with the generated drafts capability.
DraftUpdateFor
Generated input for staging an incomplete collection working draft.
UpdateOptions
Updating a draft-capable resource may explicitly stage a working draft.
OutputFor
Resolve a collection document output type.
CollectionSlug
The generated union of collection slugs.
UpdateFor
Resolve a collection update input type.
MutationOptions
Localized mutation options with optimistic concurrency.