method

RiduClient.upload

Upload a Blob with optional typed metadata.

Arguments

Argument	Type	Description
`collection`	`Slug`	The collection value.
`file`	`Blob`	The file value.
`options`	`(UploadOptions<DraftCreateFor<Config, Slug>, LocaleFor<Config>, true> & { draft?: true; }) \| undefined`	The options value.

Returns

The declared result.

Promise<OutputFor<Config, Slug>>

Full signature (2 overloads)

RiduClient.upload<Slug extends Extract<UploadCollectionSlug<Config>, DraftCollectionSlug<Config>>>(
	collection: Slug,
	file: Blob,
	options?: UploadOptions<
		DraftCreateFor<Config, Slug>,
		LocaleFor<Config>,
		true,
	> & {
		draft?: true
	},
): Promise<OutputFor<Config, Slug>>
RiduClient.upload<Slug extends UploadCollectionSlug<Config>>(
	collection: Slug,
	file: Blob,
	...args: CompleteUploadArgs<
		CreateFor<Config, Slug>,
		LocaleFor<Config>,
		CollectionDraftsFor<Config, Slug>,
	>,
): Promise<OutputFor<Config, Slug>>

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

Related types

UploadCollectionSlug
Collection slugs with the generated upload capability.
DraftCollectionSlug
Collection slugs with the generated drafts capability.
UploadOptions
Metadata and locale options accompanying an upload.
DraftCreateFor
Generated input for creating an incomplete draft-capable document.
OutputFor
Resolve a collection document output type.
CreateFor
Resolve a collection create input type.