method

RiduClient.list

List authorized collection documents with locale-, projection-, and population-dependent results.

Arguments

Argument	Type	Description
`collection`	`Slug`	The collection value.
`options`	`Options \| undefined`	The options value.

Returns

The declared result.

Promise<CollectionListEnvelope<LocaleResult<ApplySelect<ApplyPopulate<OutputFor<Config, Slug>, OptionProperty<Options, "populate">, never>, OptionProperty<Options, "select">>, ApplySelect<ApplyPopulate<AllLocalesOutputFor<Config, Slug>, OptionProperty<Options, "populate">, LocaleFor<Config>>, OptionProperty<Options, "select">>, Options>, ListPagination<Options>, Options>>

Full signature

RiduClient.list<
	Slug extends CollectionSlug<Config>,
	const Options extends ListOptions<
			WhereFor<Config, Slug>,
			SelectFor<Config, Slug>,
			PopulateFor<Config, Slug>,
			LocaleFor<Config>,
			CollectionDraftsFor<Config, Slug>,
		>
			| undefined = undefined,
>(
	collection: Slug,
	options?: Options,
): Promise<CollectionListResult<CollectionQueryResult<Config, Slug, Options>, Options>>

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

Related types

CollectionSlug
The generated union of collection slugs.
ListOptions
Typed filtering, projection, population, sorting, pagination, locale, and trash options.
WhereFor
Resolve a collection filter type.
SelectFor
Resolve a collection projection type.
PopulateFor
Resolve a collection population type.
OutputFor
Resolve a collection document output type.
AllLocalesOutputFor
Resolve locale-keyed collection output when generated, otherwise ordinary output.