Skip to main content
Version: v0.0.9

Class: NcpdpTelecomBuildError

Thrown when the Telecom builder is asked to construct an invalid-by-construction transaction. Carries a stable TelecomBuildCode, and its message is that code's TELECOM_BUILD_MESSAGES entry; like the parse error it never quotes the offending value (Telecom data is PHI-dense).

Example

try {
buildTelecomRequest({ header: {}, segments: [] });
} catch (err) {
if (err instanceof NcpdpTelecomBuildError) {
err.code; // "NCPDP_TELECOM_BUILD_MISSING_TRANSACTION_CODE"
}
}

Extends

  • Error

Constructors

Constructor

new NcpdpTelecomBuildError(code, headerField?): NcpdpTelecomBuildError

Parameters

code

TelecomBuildCode

The stable build error code, which selects the message.

headerField?

keyof TelecomHeader

The fixed-header slot at fault, when applicable.

Returns

NcpdpTelecomBuildError

Overrides

Error.constructor

Properties

code

readonly code: TelecomBuildCode

Stable, machine-readable build error code.


headerField?

readonly optional headerField?: keyof TelecomHeader

Which fixed-header field the builder rejected, when the rejection was about one. Typed as keyof TelecomHeader, so it can only ever be one of this parser's own nine header field names: it names the slot, never anything the caller supplied. Absent for rejections that are not header-field-scoped.