Huggingface.js documentation

Class: HubApiError

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Class: HubApiError

Error thrown when an API call to the Hugging Face Hub fails.

Hierarchy

  • Error

    HubApiError

Constructors

constructor

new HubApiError(url, statusCode, requestId?, message?): HubApiError

Parameters

Name Type
url string
statusCode number
requestId? string
message? string

Returns

HubApiError

Overrides

Error.constructor

Defined in

hub/src/error.ts:37

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

doc-internal/node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24


data

Optional data: JsonObject

Defined in

hub/src/error.ts:35


message

message: string

Inherited from

Error.message

Defined in

doc-internal/node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

doc-internal/node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1076


requestId

Optional requestId: string

Defined in

hub/src/error.ts:34


stack

Optional stack: string

Inherited from

Error.stack

Defined in

doc-internal/node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1078


statusCode

statusCode: number

Defined in

hub/src/error.ts:32


url

url: string

Defined in

hub/src/error.ts:33


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
Name Type
err Error
stackTraces CallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

hub/node_modules/.pnpm/@types+node@20.11.28/node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

hub/node_modules/.pnpm/@types+node@20.11.28/node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name Type
targetObject object
constructorOpt? Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

hub/node_modules/.pnpm/@types+node@20.11.28/node_modules/@types/node/globals.d.ts:21

< > Update on GitHub