ErrorPredicate | ow

Hierarchy

Predicate<Error>
- ErrorPredicate

Implements

BasePredicate<Error>

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ErrorPredicate(context?: Context): ErrorPredicate

Overrides Predicate.__constructor
- Defined in lib/predicates/error.ts:3
Parameters
- Optional context: Context
Returns ErrorPredicate

Accessors

evalError

evalError:

Test an Error to be an EvalError.

not

not:

Invert the following validators.

rangeError

rangeError:

Test an Error to be a RangeError.

referenceError

referenceError:

Test an Error to be a ReferenceError.

syntaxError

syntaxError:

Test an Error to be a SyntaxError.

typeError

typeError:

Test an Error to be a TypeError.

uriError

uriError:

Test an Error to be a URIError.

Methods

hasKeys

hasKeys(...keys: string[]): this

- Defined in lib/predicates/error.ts:49
Test the error object to have specific keys.

Parameters
- Rest ...keys: string[]
  
  One or more keys which should be part of the error object.
Returns this

instanceOf

instanceOf(instance: any): this

- Defined in lib/predicates/error.ts:61
Test an error to be of a specific instance type.

Parameters
- instance: any
  
  The expected instance type of the error.
Returns this

is

is(fn: function): this

Inherited from Predicate.is
- Defined in lib/predicates/predicate.ts:79
Test if the value matches a custom validation function. The validation function should return true if the value passes the function. If the function either returns false or a string, the function fails and the string will be used as error message.

Parameters
- fn: function
  
  Validation function.
  - - (value: Error): boolean | string
    - Parameters
      - value: Error
      Returns boolean | string
Returns this

message

message(expected: string): this

- Defined in lib/predicates/error.ts:25
Test an error to have a specific message.

Parameters
- expected: string
  
  Expected message of the Error.
Returns this

messageIncludes

messageIncludes(message: string): this

- Defined in lib/predicates/error.ts:37
Test the error message to include a specific message.

Parameters
- message: string
  
  Message that should be included in the error.
Returns this

name

name(expected: string): this

- Defined in lib/predicates/error.ts:13
Test an error to have a specific name.

Parameters
- expected: string
  
  Expected name of the Error.
Returns this