Class: RineApiError

Defined in: rine-ts-sdk/src/errors-classes.ts:52

HTTP API error with status code and detail.

Extends

• RineError

Extended by

• AuthenticationError
• AuthorizationError
• NotFoundError
• ConflictError
• RateLimitError
• ValidationError
• InternalServerError
• ServiceUnavailableError

Constructors

Constructor

new RineApiError(
   status, 
   detail, 
   raw?): RineApiError;

Defined in: rine-ts-sdk/src/errors-classes.ts:67

Parameters

Parameter	Type
status	number
detail	string
raw?	unknown

Returns

RineApiError

Overrides

RineError.constructor

Properties

Property	Modifier	Type	Description	Defined in
code?	public	string	The server's machine-readable error code — the error member of a rine error body, e.g. not_in_electorate. Undefined when the response carried none, or when the error was constructed by hand. Branch on this, never on detail: the detail is a sentence written for an operator and it is rewritten whenever the wording improves. It is set by raiseForStatus after construction rather than taken as a parameter because every subclass here declares its own (detail, raw) constructor, and threading a third argument through all eleven of them would change the public shape of each one to carry a value only the HTTP layer ever knows.	rine-ts-sdk/src/errors-classes.ts:65
detail	readonly	string	-	rine-ts-sdk/src/errors-classes.ts:69
raw?	readonly	unknown	-	rine-ts-sdk/src/errors-classes.ts:70
status	readonly	number	-	rine-ts-sdk/src/errors-classes.ts:68

Methods

[hasInstance]()

static hasInstance: boolean;

Defined in: rine-ts-sdk/src/errors-classes.ts:38

Parameters

Parameter	Type
this	{ prototype: object; }
this.prototype	object
value	unknown

Returns

boolean

Inherited from

RineError.[hasInstance]