method

RiduClient.list

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

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

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

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

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.
PageEnvelope
A paginated REST list response.
OutputFor
Resolve a collection document output type.
AllLocalesOutputFor
Resolve locale-keyed collection output when generated, otherwise ordinary output.