Class ArgumentAssertionBuilder<T>

Type parameters

T

Hierarchy

ArgumentAssertionBuilder

Implements

IArgumentAssertionBuilder<T>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ArgumentAssertionBuilder(argument: T, argumentName: string): ArgumentAssertionBuilder

- Defined in ArgumentAssertionBuilder.ts:12
Parameters
- argument: T
- argumentName: string
Returns ArgumentAssertionBuilder

Properties

argument

argument: T

argumentName

argumentName: string

Methods

isNotNull

isNotNull(): this

- Defined in ArgumentAssertionBuilder.ts:22
Ensures the argument is not null

Returns this

isNotNullOrUndefined

isNotNullOrUndefined<T>(): this

- Defined in ArgumentAssertionBuilder.ts:16
Ensures the argument is not null or undefined

Type parameters
- T
Returns this

isNotUndefined

isNotUndefined(): this

- Defined in ArgumentAssertionBuilder.ts:32
Ensures the argument is not undefined

Returns this

isOneOf

isOneOf(...options: T[]): this

- Defined in ArgumentAssertionBuilder.ts:84
Determines whether the argument is one of the specified options.

Parameters
- Rest ...options: T[]
Returns this

isTypeOf

isTypeOf<T2>(type: ConstructorFor<T2>): this

- Defined in ArgumentAssertionBuilder.ts:45
Ensures the argument is of the type

Type parameters
- T2
Parameters
- type: ConstructorFor<T2>
  
  The type
Returns this

matches

matches(predicate: Func1<T, boolean>, message?: undefined | string): this

- Defined in ArgumentAssertionBuilder.ts:59
Asserts on the value of predicate to whether the assertion is valid.

Parameters
- predicate: Func1<T, boolean>
  
  The predicate to test to see if the assertion is valid.
- Optional message: undefined | string
  
  The message to use if the assertion is invalid.
Returns this

Generated using TypeDoc