method

RiduClient.mutateJoin

Atomically add and remove IDs through a join field.

Arguments

Argument	Type	Description
`collection`	`Slug`	The collection value.
`id`	`string`	The id value.
`field`	`string`	The field value.
`input`	`JoinMutationInput`	The input value.
`options`	`MutationLocaleOptions<LocaleFor<Config>> \| undefined`	The options value.

Returns

The declared result.

Promise<JoinMutationEnvelope<OutputFor<Config, Slug>>>

Full signature

RiduClient.mutateJoin<Slug extends CollectionSlug<Config>>(
	collection: Slug,
	id: string,
	field: string,
	input: JoinMutationInput,
	options?: MutationLocaleOptions<LocaleFor<Config>>,
): Promise<JoinMutationEnvelope<OutputFor<Config, Slug>>>

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

Related types

CollectionSlug
The generated union of collection slugs.
JoinMutationInput
IDs to add and remove atomically through a join field.
MutationLocaleOptions
Locale and transport options shared by mutations without an optimistic-concurrency contract.
JoinMutationEnvelope
The updated document and actual join mutation counts.
OutputFor
Resolve a collection document output type.