method

RiduClient.delete

RiduClient.delete<Slug extends CollectionSlug<Config>>(
	collection: Slug,
	id: string,
	options?: MutationLocaleOptions<LocaleFor<Config>>,
): Promise<DeleteEnvelope>

Delete or trash one document according to collection capabilities.

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

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

Related types

CollectionSlug
The generated union of collection slugs.
MutationLocaleOptions
Locale and transport options shared by mutations without an optimistic-concurrency contract.
DeleteEnvelope
A successful delete response.