@huggingface/hub/dist/src/lib/download-file.d.ts

Utilities to interact with the Hugging Face hub

import type { CredentialsParams, RepoDesignation } from "../types/public";
import type { XetReadToken } from "../utils/XetBlob";
import type { FileDownloadInfoOutput } from "./file-download-info";
/**
 * @returns null when the file doesn't exist
 */
export declare function downloadFile(params: {
    repo: RepoDesignation;
    path: string;
    /**
     * If true, will download the raw git file.
     *
     * For example, when calling on a file stored with Git LFS, the pointer file will be downloaded instead.
     */
    raw?: boolean;
    /**
     * An optional Git revision id which can be a branch name, a tag, or a commit hash.
     *
     * @default "main"
     */
    revision?: string;
    hubUrl?: string;
    /**
     * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
     */
    fetch?: typeof fetch;
    /**
     * Whether to use the xet protocol to download the file (if applicable).
     *
     * When an object with `readToken` is provided along with `downloadInfo`,
     * the xet download can skip the token refresh roundtrip.
     *
     * @default true
     */
    xet?: boolean | {
        readToken: XetReadToken;
    };
    /**
     * Can save an http request if provided
     */
    downloadInfo?: FileDownloadInfoOutput;
} & Partial<CredentialsParams>): Promise<Blob | null>;
//# sourceMappingURL=download-file.d.ts.map