Interface IErrorHelper<TData>

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

interface IErrorHelper<TData extends DefaultErrorType = DefaultErrorType> {
    "[symbolError]": true;
    "[symbolFilePath]": string;
    httpCode?: number;
    id: string;
    meta: IErrorMeta;
    tags: TagType[];
    create(...args: ErrorThrowArgs<TData>): IRunnerError<TData>;
    is(error: unknown): error is IRunnerError<TData>;
    is(
        error: unknown,
        partialData: Partial<TData>,
    ): error is IRunnerError<TData>;
    new(...args: ErrorThrowArgs<TData>): IRunnerError<TData>;
    optional(): IOptionalDependency<IErrorHelper<TData>>;
    throw(...args: ErrorThrowArgs<TData>): never;
}

Type Parameters

TData extends DefaultErrorType = DefaultErrorType

Index

Properties

[symbolError] [symbolFilePath] httpCode? id meta tags

Methods

create is new optional throw

Properties

[symbolError]

"[symbolError]": true

Brand symbol for runtime detection

[symbolFilePath]

"[symbolFilePath]": string

File path where this error was defined

`Optional`httpCode

httpCode?: number

Optional HTTP status code associated with this error helper

id

id: string

Unique id for registration and DI

meta

meta: IErrorMeta

Metadata attached to this error

tags

tags: TagType[]

Tags attached to this error

Methods

create

create(...args: ErrorThrowArgs<TData>): IRunnerError<TData>
Alias for .new()
Parameters
- ...args: ErrorThrowArgs<TData>
Returns IRunnerError<TData>
- Defined in src/types/error.ts:78

is

is(error: unknown): error is IRunnerError<TData>
Type guard for checking if an unknown error is this error. Optionally provide a partial data object to require shallow strict matches.
Parameters
- error: unknown
Returns error is IRunnerError<TData>
- Defined in src/types/error.ts:85
is(error: unknown, partialData: Partial<TData>): error is IRunnerError<TData>
Type guard for checking if an unknown error is this error, with shallow strict matching (===) on provided data keys.
Parameters
- error: unknown
- partialData: Partial<TData>
Returns error is IRunnerError<TData>
- Defined in src/types/error.ts:90

new

new(...args: ErrorThrowArgs<TData>): IRunnerError<TData>
Construct a typed error with the given data without throwing it
Parameters
- ...args: ErrorThrowArgs<TData>
Returns IRunnerError<TData>
- Defined in src/types/error.ts:76

optional

optional(): IOptionalDependency<IErrorHelper<TData>>
Return an optional dependency wrapper for this error

Returns IOptionalDependency<IErrorHelper<TData>>
- Defined in src/types/error.ts:94

throw

throw(...args: ErrorThrowArgs<TData>): never
Throw a typed error with the given data
Parameters
- ...args: ErrorThrowArgs<TData>
Returns never
- Defined in src/types/error.ts:80