Class ClientHttpError

Error thrown on unsuccessful HTTP response.

Example

try {
  // ...
} catch (e) {
  if (e instanceof ClientHttpError) {
    // e.response and e.problemDetails can be accessed safely.
  }
}

Since

0.0.1

Hierarchy (View Summary)

InruptClientError
- ClientHttpError

Implements

Index

Constructors

constructor

Accessors

problemDetails response

Constructors

constructor

new ClientHttpError(
    responseMetadata: {
        headers: Headers;
        status: number;
        statusText: string;
        url: string;
    },
    responseBody: string,
    message: string,
    options?: ErrorOptions,
): ClientHttpError
Parameters
- responseMetadata: { headers: Headers; status: number; statusText: string; url: string }
- responseBody: string
- message: string
- Optionaloptions: ErrorOptions
Returns ClientHttpError
Overrides InruptClientError.constructor
- Defined in src/http/httpError.ts:53

Accessors

problemDetails

get problemDetails(): Readonly<
    {
        detail?: string;
        instance?: URL;
        status: number;
        title: string;
        type: URL;
    },
>
The ProblemDetails instance.

Returns Readonly<
    {
        detail?: string;
        instance?: URL;
        status: number;
        title: string;
        type: URL;
    },
>
Implementation of WithProblemDetails.problemDetails
- Defined in src/http/httpError.ts:85

response

get response(): Readonly<ResponseMetadata & { body: string; ok: false }>
Returns Readonly<ResponseMetadata & { body: string; ok: false }>
Implementation of WithErrorResponse.response
- Defined in src/http/httpError.ts:81

Class ClientHttpError

Example

Since

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Constructors

constructor

Parameters

Returns ClientHttpError

Accessors

problemDetails

Returns Readonly<
    {
        detail?: string;
        instance?: URL;
        status: number;
        title: string;
        type: URL;
    },
>

response

Returns Readonly<ResponseMetadata & { body: string; ok: false }>

Settings

On This Page

Class ClientHttpError

Example

Since

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Constructors

constructor

Parameters

Returns ClientHttpError

Accessors

problemDetails

Returns Readonly< { detail?: string; instance?: URL; status: number; title: string; type: URL; },>

response

Returns Readonly<ResponseMetadata & { body: string; ok: false }>

Settings

On This Page

Returns Readonly<
{
detail?: string;
instance?: URL;
status: number;
title: string;
type: URL;
},
>