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

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 195AuthSessionRiduClient.getUploadURLRiduClient.getUploadURLsRiduClient.readUploadSourceRiduClient.previewUploadFromURLClientOptions.fetchLivePreviewConnection.disconnectLivePreviewConnection.ready

method

RiduClient.previewUploadFromURL

Fetch a remote file for local editing without creating a document.

ArgumentsReturnsFull signature

Arguments

ArgumentTypeDescription
collectionSlugThe collection value.
urlstringThe url value.
options(RequestOptions & { id?: string; }) | undefinedThe options value.

Returns

The declared result.

Promise<UploadFile>

Full signature

RiduClient.previewUploadFromURL<Slug extends UploadCollectionSlug<Config>>( collection: Slug, url: string, options?: RequestOptions & { id?: string; }, ): Promise<UploadFile>

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

Related types

  • UploadCollectionSlug

    Collection slugs with the generated upload capability.

  • RequestOptions

    Options shared by every request.

  • UploadFile

    A downloaded file which has not yet been persisted as a document.