Class ArrayLikeArgumentAssertionBuilder<T>

Type parameters

T

Hierarchy

ArgumentAssertionBuilder<ArrayLike<T>>
- ArrayLikeArgumentAssertionBuilder

Implements

IArgumentAssertionBuilder<ArrayLike<T>>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ArrayLikeArgumentAssertionBuilder(argument: ArrayLike<T>, argumentName: string): ArrayLikeArgumentAssertionBuilder

Inherited from ArgumentAssertionBuilder.constructor
- Defined in ArgumentAssertionBuilder.ts:12
Parameters
- argument: ArrayLike<T>
- argumentName: string
Returns ArrayLikeArgumentAssertionBuilder

Properties

argument

argument: ArrayLike<T>

argumentName

argumentName: string

Methods

isNotNull

isNotNull(): this

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

Returns this

isNotNullOrUndefined

isNotNullOrUndefined<T>(): this

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

Type parameters
- T
Returns this

isNotNullOrUndefinedOrEmpty

isNotNullOrUndefinedOrEmpty(): this

- Defined in Assertions/ArrayLikeAssertions.ts:8
Ensures the array is not null, undefined or empty

Returns this

isNotUndefined

isNotUndefined(): this

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

Returns this

isOneOf

isOneOf(...options: ArrayLike<T>[]): this

Overrides ArgumentAssertionBuilder.isOneOf
- Defined in Assertions/ArrayLikeAssertions.ts:25
Parameters
- Rest ...options: ArrayLike<T>[]
Returns this

isTypeOf

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

Inherited from ArgumentAssertionBuilder.isTypeOf
- 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<ArrayLike<T>, boolean>, message?: undefined | string): this

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

Parameters
- predicate: Func1<ArrayLike<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