PostcodeError

The error that each call of PostcodeClient raises when it cannot give a result. A cancelled call raises the platform’s own abort error instead.

Example

import { PostcodeClient, PostcodeError } from '@gatepost/client';

const client = new PostcodeClient({ apiKey: process.env['NIPOST_API_KEY'] });
try {
  await client.lookup('FC-01-Z99');
} catch (error) {
  if (error instanceof PostcodeError) {
    error.code; // 'invalid_input'
    error.status; // null
  }
}

Extends

• Error

Constructors

Constructor

new PostcodeError(code, message, details?): PostcodeError

Makes an error. The client makes each one. A test of code that uses the client can make one too.

Parameters

code

PostcodeErrorCode

Why the call failed.

message

string

What happened and what to do, with no API key in it.

details?

Readonly<{ apiCode?: string | null; cause?: unknown; retryAfterMs?: number | null; status?: number | null; }> = {}

The status, the apiCode, the retryAfterMs and the cause. Each one that is missing is null.

Returns

PostcodeError

Overrides

Error.constructor

Properties

apiCode

readonly apiCode: string | null

The error.code of the response body, or null.

---

code

readonly code: PostcodeErrorCode

Why the call failed, as a stable code.

---

name

readonly name: string = 'PostcodeError'

Always PostcodeError, so that a log names the error type.

Overrides

Error.name

---

retryAfterMs

readonly retryAfterMs: number | null

The wait that Retry-After asked for, in milliseconds, or null.

---

status

readonly status: number | null

The HTTP status of the response, or null when no response arrived.