Class BcfApiError

HTTP-level failure from a BCF server (non-2xx response).

Hierarchy (View Summary)

DocumentsApiError
- BcfApiError

Index

Constructors

Properties

detail? status url

Accessors

Methods

Constructors

constructor

new BcfApiError(
message: string,
options: { detail?: string; status: number; url: string },
): BcfApiError
Parameters
- message: string
- options: { detail?: string; status: number; url: string }
Returns BcfApiError

Overrides DocumentsApiError.constructor

Properties

`Optional` `Readonly`detail

detail?: string

Server-provided error detail, when the body carried one.

`Readonly`status

status: number

HTTP status code; 0 when the request never produced a response.

`Readonly`url

url: string

Request URL with any query string, for diagnostics.

Accessors

isAuthError

get isAuthError(): boolean

True when the server rejected the credentials (sign in again).

Returns boolean

Inherited from FoundationApiError.isAuthError

Methods

`Static`[hasInstance]

"[hasInstance]"(value: unknown): boolean
Parameters
- value: unknown
Returns boolean