Skip to content
DocsReference
DocsReferenceGitHub

Search Ridu documentation

tab controls

Loading search…

Search will be ready in a moment.

No matching results

Try a different term or search every section.

Loading search.

Preparing index…View all results →↑↓ move↵ openesc close
Get started
Modules/@riducms/sdk
MRiduClient.adminCollectionList

Go packages

riducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

graphqlmcprichtextseoformbuilder@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/plugin-graphql

TypeScript packages

@riducms/sdk@riducms/sveltekit@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/admin@riducms/translations@riducms/cli/run

Tooling

ridu CLI
All@riducms/sdkriducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/sveltekit@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/plugin-graphql@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 195PublicationScheduleOptionsRichTextRenderOptions.fallbackAdminLoader.decodeAdminLoader.queryRiduClient.adminCollectionListRiduClient.adminLoadRiduClient.countGlobalVersionsRiduClient.countVersions

method

RiduClient.adminCollectionList

Framework list read model, also used for initial route preparation.

ArgumentsReturnsFull signature

Arguments

ArgumentTypeDescription
collectionstringThe collection value.
querystringThe query value.
part"page" | "counts"The part value.
optionsRequestOptions | undefinedThe options value.

Returns

The declared result.

Promise<AdminCollectionListDataV1>

Full signature

RiduClient.adminCollectionList( collection: string, query: string, part: "page" | "counts", options?: RequestOptions, ): Promise<AdminCollectionListDataV1>

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

Related types

  • RequestOptions

    Options shared by every request.