Type Alias: IBaseErrorParameters

type IBaseErrorParameters: object;

The interface for the parameters of the BaseError constructor.

Type declaration

cause?

optional cause: Error | BaseError;

The error cause.

docsPath?

optional docsPath: string;

The path to the documentation of this error.

isOperational?

optional isOperational: boolean;

The flag that indicates if this error is operational. This is useful to differentiate operational errors from programming errors. It is recommended to always set this property to true when creating a custom error class.

Default

true

Defined

@nilfoundation/niljs/src/errors/BaseError.ts:6