Class B2Error

Base error class for all B2 API errors. Contains the HTTP status, B2 error code, and retry metadata from the response.

Index

Constructors

constructor

Properties

code requestId? retryable retryAfter? status

Constructors

constructor

new B2Error(response: B2ErrorResponse, options?: B2ErrorOptions): B2Error
Creates a new B2Error instance.
Parameters
- response: B2ErrorResponse
  Parsed B2 error response body.
- Optionaloptions: B2ErrorOptions
  Optional retry and request metadata from response headers.
Returns B2Error
Overrides Error.constructor
- Defined in errors/index.ts:86

Properties

`Readonly`code

code: B2ErrorCode

B2 error code identifying the error type (e.g. expired_auth_token).

`Optional` `Readonly`requestId

requestId?: string

B2 request ID from the X-Bz-Request-Id response header, if present.

`Readonly`retryable

retryable: boolean

Whether this error is transient and the request can be retried.

`Optional` `Readonly`retryAfter

retryAfter?: number

Retry delay in seconds from the Retry-After response header, if present.

`Readonly`status

status: number

HTTP status code returned by the B2 API.

Class B2Error

Hierarchy (View Summary)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns B2Error

Properties

`Readonly`code

`Optional` `Readonly`requestId

`Readonly`retryable

`Optional` `Readonly`retryAfter

`Readonly`status

Settings

On This Page

Class B2Error

Hierarchy (View Summary)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns B2Error

Properties

Readonlycode

Optional ReadonlyrequestId

Readonlyretryable

Optional ReadonlyretryAfter

Readonlystatus

Settings

On This Page

`Readonly`code

`Optional` `Readonly`requestId

`Readonly`retryable

`Optional` `Readonly`retryAfter

`Readonly`status