Class ForbiddenError

Runtime error thrown on HTTP Forbidden (403) response.

See

RFC 9110 (15.5.4.) 403 Forbidden

Since

0.0.1

Hierarchy (View Summary)

ClientHttpError
- ForbiddenError

Index

Constructors

Accessors

problemDetails response

Constructors

constructor

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

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;
    },
>
Inherited from ClientHttpError.problemDetails
- Defined in src/http/httpError.ts:85

response

get response(): ForbiddenErrorResponse
Returns ForbiddenErrorResponse
Overrides ClientHttpError.response
- Defined in src/http/wellKnown/forbiddenError.ts:60