Type Alias ExceptionStatic<TParams, TOptions>

type ExceptionStatic<
    TParams extends ExceptionParams,
    TOptions extends ExceptionOptions,
> = {
    Instance: BaseException<TParams, TOptions>;
    asAsyncErr(
        ...args: ExceptionConstructorArgs<TParams, TOptions>,
    ): ResultAsync<never, BaseException<TParams, TOptions>>;
    asErr(
        ...args: ExceptionConstructorArgs<TParams, TOptions>,
    ): Result<never, BaseException<TParams, TOptions>>;
}

Type Parameters

TParams extends ExceptionParams
TOptions extends ExceptionOptions

Index

Properties

Methods

asAsyncErr asErr

Properties

Instance

Instance: BaseException<TParams, TOptions>

inference-only property that will be undefined at runtime

Methods

asAsyncErr

asAsyncErr(
...args: ExceptionConstructorArgs<TParams, TOptions>,
): ResultAsync<never, BaseException<TParams, TOptions>>
return an instance of the exception wrapped in a neverthrow Result
Parameters
- ...args: ExceptionConstructorArgs<TParams, TOptions>
Returns ResultAsync<never, BaseException<TParams, TOptions>>
- Defined in src/exception.ts:41

asErr

asErr(
...args: ExceptionConstructorArgs<TParams, TOptions>,
): Result<never, BaseException<TParams, TOptions>>
return an instance of the exception wrapped in a neverthrow Result
Parameters
- ...args: ExceptionConstructorArgs<TParams, TOptions>
Returns Result<never, BaseException<TParams, TOptions>>
- Defined in src/exception.ts:45