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.preview

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 195RiduAuth.apiKeysRiduClient.releaseDocumentLockRiduClient.createPreviewTokenRiduClient.revokePreviewTokenRiduClient.previewRiduClient.createGlobalPreviewTokenRiduClient.previewGlobalRiduClient.requestPlugin

method

RiduClient.preview

Read preview data using a scoped token.

ArgumentsReturnsFull signature

Arguments

ArgumentTypeDescription
collectionSlugThe collection value.
idstringThe id value.
tokenstringThe token value.
optionsRequestOptions | undefinedThe options value.

Returns

The declared result.

Promise<OutputFor<Config, Slug>>

Full signature

RiduClient.preview<Slug extends DraftCollectionSlug<Config>>( collection: Slug, id: string, token: string, options?: RequestOptions, ): Promise<OutputFor<Config, Slug>>

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

Related types

  • DraftCollectionSlug

    Collection slugs with the generated drafts capability.

  • RequestOptions

    Options shared by every request.

  • OutputFor

    Resolve a collection document output type.