method

RiduClient.mutateJoin

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

Atomically add and remove IDs through a join field.

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

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

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.