Class StringArgumentAssertionBuilder

Hierarchy

ArgumentAssertionBuilder<string>
- StringArgumentAssertionBuilder

Implements

IArgumentAssertionBuilder<string>
IArgumentAssertionBuilder<string>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StringArgumentAssertionBuilder(argument: string, argumentName: string): StringArgumentAssertionBuilder

Inherited from ArgumentAssertionBuilder.constructor
- Defined in ArgumentAssertionBuilder.ts:12
Parameters
- argument: string
- argumentName: string
Returns StringArgumentAssertionBuilder

Properties

argument

argument: string

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/StringAssertions.ts:10
Ensures the string 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: string[]): this

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

Parameters
- Rest ...options: string[]
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<string, 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<string, 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

matchesRegex

matchesRegex(regex: RegExp): this

- Defined in Assertions/StringAssertions.ts:31
Ensures the argument matches the specified regex.

Parameters
- regex: RegExp
  
  The regex.
Returns this

Generated using TypeDoc