Class SeclaiAPIStatusError

Thrown when the API returns a non-success status code.

Remarks

Use SeclaiAPIValidationError for HTTP 422 validation errors.

Hierarchy (View Summary)

SeclaiError
- SeclaiAPIStatusError
  - SeclaiAPIValidationError

Index

Constructors

Properties

method responseText statusCode url

Constructors

constructor

new SeclaiAPIStatusError(
    opts: {
        message: string;
        method: string;
        responseText: undefined | string;
        statusCode: number;
        url: string;
    },
): SeclaiAPIStatusError
Parameters
- opts: {
      message: string;
      method: string;
      responseText: undefined | string;
      statusCode: number;
      url: string;
  }
  - message: string
    Human-readable error message.
  - method: string
  - responseText: undefined | string
  - statusCode: number
  - url: string
Returns SeclaiAPIStatusError
Overrides SeclaiError.constructor
- Defined in errors.ts:42

Properties

`Readonly`method

method: string

HTTP method used for the request.

`Readonly`responseText

responseText: undefined | string

Best-effort response body text (if available).

`Readonly`statusCode

statusCode: number

HTTP status code returned by the API.

`Readonly`url

url: string

Full request URL.