Interface IErrorHelper<TData>

Runtime helper returned by defineError()/r.error(). Contains helpers to throw typed errors and perform type-safe checks.

interface IErrorHelper<TData> {
    [symbolError]: true;
    id: string;
    is(error: unknown): boolean;
    optional(): IOptionalDependency<IErrorHelper<TData>>;
    throw(data: TData): never;
}

Type Parameters

  • TData extends DefaultErrorType = DefaultErrorType

Properties

[symbolError] id

Methods

is optional throw

Properties

[symbolError]

[symbolError]: true

Brand symbol for runtime detection

id

id: string

Unique id for registration and DI

Methods

is

  • is(error): boolean

  • Type guard for checking if an unknown error is this error

    Parameters

    • error: unknown

    Returns boolean

optional

throw

Settings

Member Visibility

On This Page

Properties
Methods