Beignet API reference
    Preparing search index...

    Interface UploadDef<Name, MetadataSchema, Ctx, Result>

    Upload definition created by defineUpload(...).

    interface UploadDef<
        Name extends string = string,
        MetadataSchema extends StandardSchema = StandardSchema,
        Ctx = unknown,
        Result = unknown,
    > {
        description?: string;
        file: UploadFileConstraints;
        kind: "upload";
        metadata: MetadataSchema;
        name: Name;
        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

    Index

    Properties

    description? file kind metadata name

    Methods

    authorize? key onComplete? storageMetadata?

    Properties

    description?: string
    file: UploadFileConstraints
    kind: "upload"
    metadata: MetadataSchema
    name: Name

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods