Skip to content

flareErrorCodes

function flareErrorCodes<T extends { conflict?: Record<string, unknown>; fault?: Record<string, unknown>; forbidden?: Record<string, unknown>; invalid?: Record<string, unknown>; not_found?: Record<string, unknown>; rejected?: Record<string, unknown>; throttled?: Record<string, unknown>; too_large?: Record<string, unknown>; unauthorized?: Record<string, unknown>; unavailable?: Record<string, unknown> }>(descriptor: T): FlareErrorCodesResult<T>

Builds a frozen, branded error-codes token from a descriptor of categories and named entries.

Each entry is stamped with its own name and category. Unknown categories, malformed entries, and duplicate numeric codes are rejected.

descriptor T

returns FlareErrorCodesResult<T>

Throws:

When a category key is not a member of ErrorCategories.

Throws:

When an entry is not a plain object, omits a boolean expose, or uses a non-safe-integer code.

Throws:

When two entries declare the same numeric code.

Learn: Typed errors

Last updated: