Hugging Face的标志

Huggingface.js文档

@huggingface/hub

Hugging Face's logo
加入Hugging Face社区

并获得增强文档体验的访问权限

以开始

AccessToken

说明 AccessToken: string

实际上是 hf_${string}，但为了方便，这里使用字符串类型

定义于

hub/src/types/public.ts:15

AccessTokenRole

说明 AccessTokenRole: "admin" | "write" | "contributor" | "read"

定义于

hub/src/types/public.ts:44

认证类型

认证类型: "access_token" | "app_token" | "app_token_as_user"

定义于

hub/src/types/public.ts:46

提交操作

提交操作: CommitDeletedEntry | CommitFile

定义于

hub/src/lib/commit.ts:54

CommitProgressEvent

类型 CommitProgressEvent: { event: "phase" ; phase: "preuploading" | "uploadingLargeFiles" | "committing" } | { event: "fileProgress" ; path: string ; progress: number ; state: "hashing" | "uploading" }

定义于

hub/src/lib/commit.ts:106

ContentSource

类型 ContentSource: Blob | URL

定义于

hub/src/lib/commit.ts:35

Dtype

类型 Dtype: "F64" | "F32" | "F16" | "BF16" | "I64" | "I32" | "I16" | "I8" | "U8" | "BOOL"

定义于

hub/src/lib/parse-safetensors-metadata.ts:46

PipelineType

类型 PipelineType: keyof typeof PIPELINE_DATA

定义于

tasks/dist/src/pipelines.d.ts:404

RepoDesignation

说明 RepoDesignation: RepoId | RepoFullName

定义位置

文件路径：hub/src/types/public.ts:12

RepoFullName

说明 RepoFullName: string | `spaces/${string}` | `datasets/${string}`

定义位置

文件路径：hub/src/types/public.ts:10

RepoType

类型 RepoType: "space" | "dataset" | "model"

定义在

hub/src/types/public.ts:3

SafetensorsFileHeader

类型 SafetensorsFileHeader: Record<TensorName, TensorInfo> & { __metadata__: Record<string, string> }

定义在

hub/src/lib/parse-safetensors-metadata.ts:54

SafetensorsParseFromRepo

定义 SafetensorsParseFromRepo: { header: SafetensorsFileHeader ; parameterCount?: Partial<Record<Dtype, number>> ; sharded: false } | { headers: SafetensorsShardedHeaders ; index: SafetensorsIndexJson ; parameterCount?: Partial<Record<Dtype, number>> ; sharded: true }

定义于

hub/src/lib/parse-safetensors-metadata.ts:68

SafetensorsShardedHeaders

定义 SafetensorsShardedHeaders: Record<FileName, SafetensorsFileHeader>

定义于

hub/src/lib/parse-safetensors-metadata.ts:66

SpaceHardwareFlavor

Conflict SpaceHardwareFlavor: "cpu-basic" | "cpu-upgrade" | "t4-small" | "t4-medium" | "a10g-small" | "a10g-large" | "a100-large"

定义于

hub/src/types/public.ts:21

SpaceSdk

Conflict SpaceSdk: "streamlit" | "gradio" | "docker" | "static"

定义于

hub/src/types/public.ts:30

SpaceStage

备注 SpaceStage: "NO_APP_FILE" | "CONFIG_ERROR" | "BUILDING" | "BUILD_ERROR" | "RUNNING" | "RUNNING_BUILDING" | "RUNTIME_ERROR" | "DELETING" | "PAUSED" | "SLEEPING"

定义于

hub/src/types/public.ts:32

TensorName

备注 TensorName: string

定义于

hub/src/lib/parse-safetensors-metadata.ts:45

WhoAmI

Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser

定义于

hub/src/lib/who-am-i.ts:50

变量

RE _ SAFETENSORS _ FILE

• Const RE_SAFETENSORS_FILE: RegExp

定义于

hub/src/lib/parse-safetensors-metadata.ts:15

RE _ SAFETENSORS _ INDEX _ FILE

• Const RE_SAFETENSORS_INDEX_FILE: RegExp

定义于

hub/src/lib/parse-safetensors-metadata.ts:16

RE _ SAFETENSORS _ SHARD _ FILE

• Const RE_SAFETENSORS_SHARD_FILE: RegExp

定义于

hub/src/lib/parse-safetensors-metadata.ts:17

SAFETENSORS _ FILE

• Const SAFETENSORS_FILE: "model.safetensors"

定义于

hub/src/lib/parse-safetensors-metadata.ts:11

SAFETENSORS _ INDEX _ FILE

• Const SAFETENSORS_INDEX_FILE: "model.safetensors.index.json"

定义于

hub/src/lib/parse-safetensors-metadata.ts:12

函数

m _ internal _ sha256

▸ __internal_sha256(buffer, opts?): AsyncGenerator<number, string>

参数

名称 类型
缓存 Blob
opts? 对象
opts.abortSignal? AbortSignal
opts.useWebWorker? 布尔值 | { minSize?: 数字 ; poolSize?: 数字 }

返回

AsyncGenerator<数字, 字符串>

十六进制编码的 sha

产生

进度 (0-1)

定义于

hub/src/utils/sha256.ts:72

提交

▸ 提交(params): Promise<CommitOutput>

参数

名称 类型
params CommitParams

返回值

Promise<CommitOutput>

定义在

hub/src/lib/commit.ts:553

commitIter

▸ commitIter(params): AsyncGenerator<CommitProgressEvent, CommitOutput>

目前为内部函数，由 commit 使用。

以后可以公开以提供更精确的进度信息。

参数

名称 类型
params CommitParams

返回值

AsyncGenerator<CommitProgressEvent, CommitOutput>

定义在

hub/src/lib/commit.ts:123

countCommits

▸ countCommits(params): Promise<number>

参数

名称 类型 描述
params 对象 -
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> MDN 引用
params.hubUrl? 字符串 -
params.repo 仓库指定 -
params.revision? 字符串 列出提交的修订版本。默认为默认分支。

返回值

Promise\<number>

定义于

hub/src/lib/count-commits.ts:7

createRepo

▸ createRepo(params): Promise\<{ repoUrl: string }\>

参数

名称 类型 描述
params 对象 -
params.credentials Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.files? { content: ArrayBuffer | Blob ; path: string }[] 创建仓库名义下仅支持少数轻量级文件
params.hubUrl? 字符串 -
params.license? 字符串 -
params.private? 布尔类型 -
params.repo 仓库指定 -
params.sdk? SpaceSdk Required 当仓库名称类型 === “domain” 时使用

返回

Promise<{ repoUrl: string }>

定义于

hub/src/lib/create-repo.ts:9

删除文件

▸ 删除文件(params): Promise<提交输出>

参数

名称 类型
params 对象
params.branch? 字符串
params.commitDescription? 字符串
params.commitTitle? 字符串
params.credentials Credentials
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response>
params.hubUrl? 字符串
params.isPullRequest? 布尔类型
params.parentCommit? 字符串
params.path 字符串
params.repo 仓库指定

返回值

Promise<CommitOutput>

定义于

hub/src/lib/delete-file.ts:5

deleteFiles

▸ deleteFiles(params): Promise<CommitOutput>

参数

名称 类型
params 对象
params.branch? 字符串
params.commitDescription? 字符串
params.commitTitle? 字符串
params.credentials Credentials
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response>
params.hubUrl? 字符串
params.isPullRequest? 布尔类型
params.parentCommit? 字符串
params.paths 字符串[]
params.repo 仓库指定

返回值

Promise<CommitOutput>

定义于

hub/src/lib/delete-files.ts:5

deleteRepo

▸ deleteRepo(params): Promise<void>

参数

名称 类型 描述
params 对象 -
params.credentials Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.repo 仓库指定 -

返回值

Promise<void>

定义于

hub/src/lib/delete-repo.ts:7

downloadFile

▸ downloadFile(params): Promise<Response | null>

参数

名称 类型 描述
params 对象 -
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.path 字符串 -
params.range? [number, number] 仅获取文件的特定部分
params.raw? 布尔类型 如果为 true，将下载原始 git 文件。例如，当调用存储在 Git LFS 中的文件时，将下载指针文件。
params.repo 仓库指定 -
params.revision? 字符串 一个可选的 Git 修订版本号，可以是一个分支名称、标签或提交 hash。默认 ts "main"

返回值

Promise<Response | null>

当文件不存在时为 null

定义在

hub/src/lib/download-file.ts:10

fileDownloadInfo

▸ fileDownloadInfo(params): Promise<FileDownloadInfoOutput | null>

参数

名称 类型 描述
params 对象 -
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.noContentDisposition? 布尔类型 为了避免在LFS文件中的downloadLink使用content-disposition头，以便在浏览器中使用URL在iframe中，例如。
params.path 字符串 -
params.raw? 布尔类型 获取LFS文件背后的原始指针文件。
params.repo 仓库指定 -
params.revision? 字符串 -

返回值

Promise<FileDownloadInfoOutput | null>

当文件不存在时为 null

定义于

hub/src/lib/file-download-info.ts:18

fileExists

▸ fileExists(params): Promise<boolean>

参数

名称 类型 描述
params 对象 -
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.path 字符串 -
params.repo 仓库指定 -
params.revision? 字符串 -

返回值

Promise<boolean>

定义于

hub/src/lib/file-exists.ts:7

listCommits

▸ listCommits(params): AsyncGenerator<CommitData>

参数

名称 类型 描述
params 对象 -
params.batchSize? 数字 每次http调用从中心获取的提交数。默认为100。可以设置为1000。
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.repo 仓库指定 -
params.revision? 字符串 列出提交的修订版本。默认为默认分支。

返回值

AsyncGenerator<CommitData>

定义于

hub/src/lib/list-commits.ts:17

listDatasets

▸ listDatasets<\code>T>(params?): AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

类型参数

名称 类型
T extends "描述" | "作者" | "卡片数据" | "禁用" | "gitalyUid" | "创建于" | "标签" | "paperswithcode_id" | "sha" | "引用" | "下载次数（总）" = never

参数

名称 类型 描述
params? 对象 -
params.additionalFields? T[] -
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.limit? 数字 设置为限制返回模型的数量。
params.search? 对象 -
params.search.owner? 字符串 -
params.search.query? 字符串 将在数据集名称中搜索匹配项。
params.search.tags? 字符串[] -

返回值

AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

定义于

hub/src/lib/list-datasets.ts:47

listFiles

▸ listFiles(params): AsyncGenerator<ListFileEntry>

列出文件夹中的文件。要列出目录中的所有文件，请将params.recursive设置为true。

参数

名称 类型 描述
params 对象 -
params.credentials? Credentials -
params.expand? 布尔类型 为主体文件的每个文件，获取lastCommit和securityStatus。
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.path? 字符串 例如，使用'data'列出'data'文件夹中的所有文件。如果为空，则列出仓储项目中的所有文件。
params.recursive? 布尔类型 我们是否想要列出子目录中的文件？
params.repo 仓库指定 -
params.revision? 字符串 -

返回值

AsyncGenerator<ListFileEntry>

定义于

hub/src/lib/list-files.ts:38

listModels

▸ listModels<T>(params?): AsyncGenerator<ModelEntry & Pick<ApiModelInfo, T>>

类型参数

名称 类型
T 扩展 "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "sha" | "downloadsAllTime" | "config" | "library_name" | "spaces" | "model-index" | "safetensors" | "transformersInfo" = never

参数

名称 类型 描述
params? 对象 -
params.additionalFields? T[] -
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.limit? 数字 设置为限制返回模型的数量。
params.search? 对象 -
params.search.owner? 字符串 -
params.search.query? 字符串 将在模型名称中进行匹配搜索
params.search.tags? 字符串[] -
params.search.task? "other" | "text-classification" | "token-classification" | "table-question-answering" | "question-answering" | "zero-shot-classification" | "translation" | "summarization" | "feature-extraction" | "text-generation" | "text2text-generation" | "fill-mask" | "sentence-similarity" | "text-to-speech" | "text-to-audio" | "automatic-speech-recognition" | "audio-to-audio" | "audio-classification" | "voice-activity-detection" | "depth-estimation" | "image-classification" | "object-detection" | "image-segmentation" | "text-to-image" | "image-to-text" | "image-to-image" | "image-to-video" | "unconditional-image-generation" | "video-classification" | "reinforcement-learning" | "robotics" | "tabular-classification" | "tabular-regression" | "tabular-to-text" | "table-to-text" | "multiple-choice" | "text-retrieval" | "time-series-forecasting" | "text-to-video" | "image-text-to-text" | "visual-question-answering" | "document-question-answering" | "zero-shot-image-classification" | "graph-ml" | "mask-generation" | "zero-shot-object-detection" | "text-to-3d" | "image-to-3d" | "image-feature-extraction" | "video-text-to-text" -

返回值

AsyncGenerator<ModelEntry & Pick<ApiModelInfo, T>>

定义在

hub/src/lib/list-models.ts:53

listSpaces

▸ listSpaces<T>(params?): AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

类型参数

名称 类型
T 继承自 "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "sha" | "subdomain" | "runtime" | "models" | "datasets" = never

参数

名称 类型 描述
params? 对象 -
params.additionalFields? T[] 从 huggingface.co 获取的额外字段。
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.search? 对象 -
params.search.owner? 字符串 -
params.search.query? 字符串 将在空间名称中搜索匹配项。
params.search.tags? 字符串[] -

返回值

AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

定义于

hub/src/lib/list-spaces.ts:39

oauthHandleRedirect

▸ oauthHandleRedirect(opts?): Promise<OAuthResult>

在OAuth提供者重定向回应用程序后调用。

还有一个辅助函数oauthHandleRedirectIfPresent，如果URL的查询参数中包含oauth代码，则调用oauthHandleRedirect，否则返回false。

参数

名称 类型
opts? 对象
opts.hubUrl? 字符串

返回值

Promise<OAuthResult>

定义于

hub/src/lib/oauth-handle-redirect.ts:42

oauthHandleRedirectIfPresent

▸ oauthHandleRedirectIfPresent(opts?): Promise< OAuthResult | false>

在OAuth提供者重定向回应用程序后调用。

如果URL中不包含查询参数中的oauth代码，则返回false，否则调用OAuthHandleRedirect。

根据你的应用程序，你可能希望直接调用OAuthHandleRedirect。

参数

名称 类型
opts? 对象
opts.hubUrl? 字符串

返回值

Promise<OAuthResult | false>

定义于

hub/src/lib/oauth-handle-redirect.ts:210

oauthLoginUrl

▸ oauthLoginUrl(opts?): Promise<string>

使用“通过Hub登录”来验证用户，并获取oauth用户信息/访问令牌。

返回要重定向的URL。用户重定向回您的应用程序后，请调用oauthHandleRedirect以获取oauth用户信息/访问令牌。

在启用OAuth的静态空间内部调用时，将从此空间加载配置，否则您至少需要指定OAuth应用的客户端ID。

参数

名称 类型 描述
opts? 对象 -
opts.clientId? 字符串 OAuth客户端ID。对于静态Spaces，您可以省略此参数，因为如果README.md的元数据中存在hf_oauth: true，它将被从空间配置中加载。对于其他Spaces，它将通过OAUTH_CLIENT_ID环境变量提供给后端，前提是README.md的元数据中存在hf_oauth: true。您也可以在https://huggingface.co/settings/connected-applications创建开发者应用程序并使用其客户端ID。
opts.hubUrl? 字符串 -
opts.redirectUrl? 字符串 重定向URI，默认为当前URL。对于Spaces，允许空间内的任何URL。对于开发者应用程序，您可以在https://huggingface.co/settings/connected-applications中将任何URL添加到允许的重定向URI列表中。
opts.scopes? 字符串 OAuth作用域，作用域列表由空格分隔。对于静态Spaces，您可以使用省略此参数，因为它将根据空间配置加载，前提是README.md的元数据中存在hf_oauth: true。对于其他Spaces，它将通过OAUTH_SCOPES环境变量提供给后端，前提是README.md的元数据中存在hf_oauth: true。默认为“openid profile”。您也可以在https://huggingface.co/settings/connected-applications中创建开发者应用程序并使用其作用域。有关可用作用域的列表，请参阅https://huggingface.co/docs/hub/oauth。
opts.state? 字符串 要传递给OAuth提供者的State，它将在重定向后调用oauthLogin时返回。

返回

Promise<string>

示例

import { oauthLoginUrl, oauthHandleRedirectIfPresent } from "@huggingface/hub";

const oauthResult = await oauthHandleRedirectIfPresent();

if (!oauthResult) {
  // If the user is not logged in, redirect to the login page
  window.location.href = await oauthLoginUrl();
}

// You can use oauthResult.accessToken, oauthResult.accessTokenExpiresAt and oauthResult.userInfo
console.log(oauthResult);

（理论上，这个函数可用于通过更改hubUrl对任何支持PKCE和OpenID Connect的OAuth提供商进行用户验证，但目前只对其进行了Hugging Face Hub的测试。）

定义在

hub/src/lib/oauth-login-url.ts:31

parseSafetensorsMetadata

▸ parseSafetensorsMetadata(params): Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>

使用智能范围请求分析Hugging Face上托管模型的model.safetensors.index.json或model.safetensors，以提取其元数据。

参数

名称 类型 描述
params 对象 -
params.computeParametersCount true 将包含SafetensorsParseFromRepo[“参数数量”]，一个包含每个DType 默认值 ts false
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.path? 字符串 相对于存储库内safetensors文件的相对文件路径。默认为SAFETENSORS_FILE或SAFETENSORS_INDEX_FILE（存在则使用其中的一个）。
params.repo 仓库指定 仅支持模型。
params.revision? 字符串 -

返回值

Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>>

定义于

hub/src/lib/parse-safetensors-metadata.ts:180

▸ parseSafetensorsMetadata(params): Promise<SafetensorsParseFromRepo>

参数

名称 类型 描述
params 对象 -
params.computeParametersCount? 布尔类型 -
params.credentials? Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -
params.path? 字符串 将包含SafetensorsParseFromRepo[“参数数量”]，一个包含每个DType 默认值 ts false
params.repo 仓库指定 仅支持模型。
params.revision? 字符串 -

返回值

Promise<SafetensorsParseFromRepo>

定义于

hub/src/lib/parse-safetensors-metadata.ts:201

parseSafetensorsShardFilename

▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null

参数

名称 类型
filename 字符串

返回值

SafetensorsShardFileInfo | null

定义于

hub/src/lib/parse-safetensors-metadata.ts:25

uploadFile

▸ uploadFile(params): Promise<CommitOutput>

参数

名称 类型
params 对象
params.abortSignal? AbortSignal
params.branch? 字符串
params.commitDescription? 字符串
params.commitTitle? 字符串
params.credentials? Credentials
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response>
params.file URL | File | { content: ContentSource ; path: string }
params.hubUrl? 字符串
params.isPullRequest? 布尔类型
params.parentCommit? 字符串
params.repo 仓库指定
params.useWebWorkers? 布尔值 | { minSize?: 数字 ; poolSize?: 数字 }

返回

Promise<CommitOutput>

定义在

hub/src/lib/upload-file.ts:5

uploadFiles

▸ uploadFiles(params): Promise<CommitOutput>

参数

名称 类型
params 对象
params.abortSignal? AbortSignal
params.branch? 字符串
params.commitDescription? 字符串
params.commitTitle? 字符串
params.credentials? Credentials
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response>
params.files (URL | File | { content: ContentSource ; path: string })[]
params.hubUrl? 字符串
params.isPullRequest? 布尔类型
params.parentCommit? 字符串
params.repo 仓库指定
params.useWebWorkers? 布尔值 | { minSize?: 数字 ; poolSize?: 数字 }

返回值

Promise<CommitOutput>

定义于

hub/src/lib/upload-files.ts:4

uploadFilesWithProgress

▸ uploadFilesWithProgress(params): AsyncGenerator<CommitProgressEvent, CommitOutput>

带有进度上传

需要处理上传的进度事件，确保 XMLHttpRequest 可用 Set useWebWorkers 为 true 以获取哈希进度事件

参数

名称 类型 描述
params 对象 -
params.abortSignal? AbortSignal -
params.branch? 字符串 -
params.commitDescription? 字符串 -
params.commitTitle? 字符串 -
params.credentials? Credentials -
params.files (URL | File | { content: ContentSource ; path: string })[] -
params.hubUrl? 字符串 -
params.isPullRequest? 布尔类型 -
params.parentCommit? 字符串 -
params.repo 仓库指定 -
params.useWebWorkers? 布尔值 | { minSize?: 数字 ; poolSize?: 数字 } 将其设置为true以便开启哈希进度事件

返回

AsyncGenerator<CommitProgressEvent, CommitOutput>

定义于

hub/src/lib/upload-files-with-progress.ts:19

whoAmI

▸ whoAmI(params): Promise\<WhoAmI & { auth: AuthInfo }>

参数

名称 类型 描述
params 对象 -
params.credentials Credentials -
params.fetch? (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> 自定义fetch函数以替代默认函数，例如使用代理或编辑头信息。
params.hubUrl? 字符串 -

返回值

Promise<WhoAmI & { auth: AuthInfo }>

定义于

hub/src/lib/who-am-i.ts:61

< > 在GitHub上更新

←与Hub互动 HubApiError→