@huggingface/hub
Version:
Utilities to interact with the Hugging Face hub
28 lines • 1.16 kB
TypeScript
import type { CredentialsParams } from "../types/public";
import type { CommitOutput, CommitParams, CommitProgressEvent, ContentSource } from "./commit";
/**
* Uploads with progress
*
* Needs XMLHttpRequest to be available for progress events for uploads
* Set useWebWorkers to true in order to have progress events for hashing
*/
export declare function uploadFilesWithProgress(params: {
repo: CommitParams["repo"];
files: Array<URL | File | {
path: string;
content: ContentSource;
}>;
commitTitle?: CommitParams["title"];
commitDescription?: CommitParams["description"];
hubUrl?: CommitParams["hubUrl"];
branch?: CommitParams["branch"];
isPullRequest?: CommitParams["isPullRequest"];
parentCommit?: CommitParams["parentCommit"];
abortSignal?: CommitParams["abortSignal"];
maxFolderDepth?: CommitParams["maxFolderDepth"];
/**
* Set this to true in order to have progress events for hashing
*/
useWebWorkers?: CommitParams["useWebWorkers"];
} & Partial<CredentialsParams>): AsyncGenerator<CommitProgressEvent, CommitOutput>;
//# sourceMappingURL=upload-files-with-progress.d.ts.map