CustomError

Return a new CustomError

@example

const parentError: Error;
const error = CustomError({
  name: 'FooError' as const, // this is required
  message: 'my custom message', // customize message (optional)
  cause: parentError, // Error that caused this error (optional)
})

@param

initial properties

Index

Interfaces

• Module

Type Aliases

• Parameters
• ParametersProperties

Interfaces

Module

• Module(...properties: Parameters<Model>): Model

readonlycreate

create: (...properties: Parameters<Model>) => Model

Return a new CustomError

@example

const MyError = CustomError.define('MyError1');
const error = MyError.create({
  message: 'my custom message', // customize message (optional)
  cause: parentError, // Error that caused this error (optional)
})

readonlyerrorName

errorName: Model[name]

The model name constant. Can be useful for switch / case statements.

@example

const error: SomeError;
switch (error.name) {
  case SomeError.errorName: //...
}

readonlyhasInstance

hasInstance: (anyValue: unknown) => anyValue is Model

Predicate that returns true when anyValue is a Model The implementation compares anyValue.name === Module.errorName

@example

const MyError = CustomError.define('MyError1');
const unknownError: unknown;
if (MyError.hasInstance(unknownError)) {
  // unknownError.name === 'MyError1'
}

Type Aliases

Parameters

Parameters<Model>: RequiredKeysOf<Omit<Model, name | stack | message | cause>> extends never ? [properties?: ParametersProperties<Model>] : [properties: ParametersProperties<Model>]

Extract all parameters to create a new CustomError

---

Type parameters

• Model: object

ParametersProperties

ParametersProperties<Model>: Omit<Model, name | stack | message | cause> & Partial<Pick<CustomError<{ name: string }>, message | cause>>

Extract all properties passed to constructor

---

Type parameters

• Model: object