Beignet API reference
    Preparing search index...

    Interface DefineUploadOptions<MetadataSchema, Ctx, Result>

    Upload definition options.

    interface DefineUploadOptions<
        MetadataSchema extends StandardSchema,
        Ctx,
        Result,
    > {
        access?: UploadAccess;
        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>;
        verifyFile?(
            args: UploadVerifyFileHookArgs<InferSchemaOutput<MetadataSchema>, Ctx>,
        ): MaybePromise<UploadFileVerificationResult>;
    }

    Type Parameters

    Index
    access? description? file metadata
    authorize? key onComplete? storageMetadata? verifyFile?
    access?: UploadAccess

    Whether this upload may be prepared without an authorize hook.

    "protected"
    description?: string

    Optional human-readable description for docs and tooling.

    file: UploadFileConstraints

    File constraints for this upload workflow.

    metadata: MetadataSchema

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

    Settings
    Member Visibility

    On This Page
    Properties
    Methods