Interface DefineUploadOptions<MetadataSchema, Ctx, Result>

Upload definition options.

interface DefineUploadOptions<
    MetadataSchema extends StandardSchema,
    Ctx,
    Result,
> {
    description?: string;
    file: UploadFileConstraints;
    metadata: MetadataSchema;
    authorize?(
        args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
    ): MaybePromise<UploadAuthorizeResult>;
    key(
        args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
    ): MaybePromise<string>;
    onComplete?(
        args: UploadCompleteHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
    ): MaybePromise<Result>;
    storageMetadata?(
        args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
    ): MaybePromise<StorageMetadata>;
}

Type Parameters

MetadataSchema extends StandardSchema
Ctx
Result

Index

Properties

description? file metadata

Methods

authorize? key onComplete? storageMetadata?

Properties

`Optional`description

description?: string

Optional human-readable description for docs and tooling.

file

file: UploadFileConstraints

File constraints for this upload workflow.

metadata

metadata: MetadataSchema

Metadata schema submitted with prepare, server upload, and complete calls.

Methods

`Optional`authorize

authorize?(
args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
): MaybePromise<UploadAuthorizeResult>
Check whether the current actor may start this upload.
Parameters
- args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>
Returns MaybePromise<UploadAuthorizeResult>
- Defined in packages/core/src/uploads/index.ts:237

key

key(
args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
): MaybePromise<string>
Build the storage key for one file.
Parameters
- args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>
Returns MaybePromise<string>
- Defined in packages/core/src/uploads/index.ts:243

`Optional`onComplete

onComplete?(
args: UploadCompleteHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
): MaybePromise<Result>
Run after files exist in storage.
Parameters
- args: UploadCompleteHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>
Returns MaybePromise<Result>
- Defined in packages/core/src/uploads/index.ts:255

`Optional`storageMetadata

storageMetadata?(
args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
): MaybePromise<StorageMetadata>
Add storage metadata for one file.
Parameters
- args: UploadFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>
Returns MaybePromise<StorageMetadata>
- Defined in packages/core/src/uploads/index.ts:249