Class: APIError

Defined in: particiapp-web-client.js:254

The APIError class represents an error due to an unknown API error.

Extends

• HTTPError

Extended by

• AuthenticationRequiredError

Constructors

new APIError()

new APIError(status, problemDetails): APIError

Defined in: particiapp-web-client.js:261

The constructor returns a newly created APIError object.

Parameters

status

number

The HTTP status code returned by the server.

problemDetails

APIProblemDetails

The problem details JSON object returned by the server.

Returns

APIError

Overrides

HTTPError.constructor

Properties

cause?

optional cause: unknown;

Defined in: ../../../../root/.npm/_npx/4661334f0781fdbe/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

HTTPError.cause

---

detail

detail: string;

Defined in: particiapp-web-client.js:272

The detail property contains a human-readable explanation specific to this occurrence of the problem returned by the server.

---

message

message: string;

Defined in: ../../../../root/.npm/_npx/4661334f0781fdbe/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

HTTPError.message

---

name

name: string;

Defined in: ../../../../root/.npm/_npx/4661334f0781fdbe/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

HTTPError.name

---

stack?

optional stack: string;

Defined in: ../../../../root/.npm/_npx/4661334f0781fdbe/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

HTTPError.stack

---

status

status: number;

Defined in: particiapp-web-client.js:246

Inherited from

HTTPError.status

---

type

type: string;

Defined in: particiapp-web-client.js:267

The type property contains a URI reference that identifies the problem type returned by the server.