#
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

packages/hub/src/error.ts:40

##
Properties

###
cause

• `Optional` cause: `unknown`

####
Inherited from

Error.cause

####
Defined in

packages/doc-internal/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

###
data

• `Optional` data: `JsonObject`

####
Defined in

packages/hub/src/error.ts:38

###
message

• message: `string`

####
Inherited from

Error.message

####
Defined in

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

###
name

• name: `string`

####
Inherited from

Error.name

####
Defined in

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

###
requestId

• `Optional` requestId: `string`

####
Defined in

packages/hub/src/error.ts:37

###
stack

• `Optional` stack: `string`

####
Inherited from

Error.stack

####
Defined in

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

###
statusCode

• statusCode: `number`

####
Defined in

packages/hub/src/error.ts:35

###
url

• url: `string`

####
Defined in

packages/hub/src/error.ts:36

###
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

node_modules/.pnpm/@types+node@22.14.1/node_modules/@types/node/globals.d.ts:143

###
stackTraceLimit

▪ `Static` stackTraceLimit: `number`

####
Inherited from

Error.stackTraceLimit

####
Defined in

node_modules/.pnpm/@types+node@22.14.1/node_modules/@types/node/globals.d.ts:145

##
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

node_modules/.pnpm/@types+node@22.14.1/node_modules/@types/node/globals.d.ts:136

Update on GitHub