SeyfertError Class

Base error type used by Seyfert. It supports optional machine-readable metadata and preserves the original cause when wrapping lower-level errors.

seyfertlib/common/it/error.d.ts

Signature

export declare class SeyfertError extends Error

JSDoc

Examples

throw new SeyfertError('INVALID_TOKEN', {
  metadata: { shardId: 0 },
});

@remarksFor validation errors, prefer structured metadata (you can use {@link createValidationMetadata }) with: - `expected`: expected value or shape - `received`: received value - `receivedType`: optional primitive/runtime type

Properties

name code metadata

Methods

is constructor toJSON

Properties

name

name: string;

Error name used in logs and stack traces.

code

code: SeyfertErrorCode;

Optional machine-readable error identifier.

metadata

metadata?: Record<string, unknown>;

Optional contextual data attached to the error.

Methods

is

static is(error: unknown): error is SeyfertError;static is<C extends SeyfertErrorCode>(error: unknown, code: C): error is SeyfertError & {    code: C;};

constructorConstructor

constructor(code: SeyfertErrorCode, options?: {    metadata?: Record<string, unknown>;    cause?: unknown;});

toJSON

toJSON(): {    name: string;    message: string;    code: SeyfertErrorCode;    metadata: Record<string, unknown> | undefined;    cause: unknown;};

Serializes the error into a plain object.

Returns

Serializable error payload including name, message, code, metadata and cause.