method

RiduClient.delete

Delete or trash one document according to collection capabilities.

Arguments

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

Returns

The declared result.

Promise<DeleteEnvelope>

Full signature

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

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

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.