Class CancellationError

Thrown when a request is aborted via an AbortSignal. Uses the nginx convention statusCode = 499 to distinguish client cancellation.

Hierarchy (View Summary)

BugBugError
- CancellationError

Index

Constructors

Properties

code statusCode response? request? cause?

Methods

Constructors

constructor

new CancellationError(
message?: string,
request?: RequestOrigin,
): CancellationError
Parameters
- message: string = 'Request was cancelled'
- Optionalrequest: RequestOrigin
Returns CancellationError
Overrides BugBugError.constructor
- Defined in sdk/src/types/errors.ts:289

Properties

`Readonly`code

code: SdkErrorCode

`Readonly`statusCode

statusCode: number

`Optional` `Readonly`response

response?: Response

`Optional` `Readonly`request

request?: RequestOrigin

`Optional` `Readonly`cause

cause?: Error

Methods

toJSON

toJSON(): {
    name: string;
    code: SdkErrorCode;
    message: string;
    statusCode: number;
    request: RequestOrigin
    | undefined;
    stack: string | undefined;
}
Returns {
    name: string;
    code: SdkErrorCode;
    message: string;
    statusCode: number;
    request: RequestOrigin | undefined;
    stack: string | undefined;
}
Inherited from BugBugError.toJSON
- Defined in sdk/src/types/errors.ts:68