mlx-bun library API
    Preparing search index...

    Interface UploadOptions

    interface UploadOptions {
        allowPatterns?: string[];
        baseUrl?: string;
        commitMessage?: string;
        onProgress?: (file: string, sent: number, total: number) => void;
        private?: boolean;
        repoType?: RepoType;
        signal?: AbortSignal;
        token: string | null;
    }
    Index
    allowPatterns? baseUrl? commitMessage? onProgress? private? repoType? signal? token
    allowPatterns?: string[]

    Optional glob-free prefix/substring allowlist; if set, only files whose repo path includes one of these substrings are uploaded.

    baseUrl?: string

    Override the Hub base URL — tests point this at a local mock.

    commitMessage?: string
    onProgress?: (file: string, sent: number, total: number) => void

    Per-file progress: (repoPath, bytesSent, bytesTotal).

    private?: boolean
    repoType?: RepoType
    signal?: AbortSignal

    Cancels the upload: the in-flight request is aborted, no later step runs, and the promise rejects with the signal's reason. No request starts once cancellation is observed; a commit already submitted may have been accepted.

    token: string | null

    Required: callers choose authentication; null sends no bearer token.

    Settings
    Member Visibility

    On This Page
    Properties