Interface AssertOrThrowProps<ARGS>

Props for performing assertions that throw. - args for evaluation

interface AssertOrThrowProps<ARGS> {
    args: ARGS;
    assertion: (args: ARGS) => boolean;
    errorMessage?: string | AssertMessageGenerator<ARGS>;
}

Type Parameters

ARGS

Index

Properties

args assertion errorMessage?

Properties

args

args: ARGS

Args to use in assertion.

assertion

assertion: (args: ARGS) => boolean

Assertion function that performs assertion.

Type declaration

- (args: ARGS): boolean
- Parameters
  - args: ARGS
  Returns boolean
  if assertion passed

`Optional`errorMessage

errorMessage?: string | AssertMessageGenerator<ARGS>

Error message function or string to be included in thrown exception.

Param: args

of assert for generating message

Returns

error message to include in assertion exception