TimeoutError

Callable

• TimeoutError(...properties: [properties?: ParametersProperties<TimeoutError>]): TimeoutError

---

• TimeoutError constructor

Index

Constructor

• create

Other

• errorName
• hasInstance

Constructor

readonlycreate

create: (...properties: [properties?: ParametersProperties<TimeoutError>]) => TimeoutError

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)
})

Other

readonlyerrorName

errorName: TimeoutError

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 TimeoutError

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'
}