Class default

Interface for implementing your own builder.

See

ArgumentAssertionBuilder

Hierarchy

default<string>
- default

Implements

IArgumentAssertionBuilder<string>

Index

Constructors

Properties

argument argumentName

Methods

isEqualTo isGreaterThan isGreaterThanOrEqualTo isLessThan isLessThanOrEqualTo isNotEmpty isNotNull isNotNullOrUndefined isNotNullOrUndefinedOrEmpty isNotUndefined isOneOf isTypeOf matches matchesRegex

Constructors

constructor

new default(argument, argumentName): default
Parameters
- argument: string
- argumentName: string
Returns default
Inherited from default.constructor
- Defined in src/Assertions/ArgumentAssertionBuilder.ts:28

Properties

`Readonly` argument

argument: string

`Readonly` argumentName

argumentName: string

Methods

isEqualTo

isEqualTo<T>(value): default
Ensures the string is equal to the specified value.
Type Parameters
- T extends IComparable
Parameters
- value: T
  The value.
Returns default
Throws
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:127

isGreaterThan

isGreaterThan<T>(value): default
Ensures the string is greater than the specified value.
Type Parameters
- T extends IComparable
Parameters
- value: T
  The value.
Returns default
Throws
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:113

isGreaterThanOrEqualTo

isGreaterThanOrEqualTo<T>(value): default
Ensures the string is greater than or equal to the specified value.
Type Parameters
- T extends IComparable
Parameters
- value: T
  The value.
Returns default
Throws
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:71

isLessThan

isLessThan<T>(value): default
Ensures the string is less than the specified value.
Type Parameters
- T extends IComparable
Parameters
- value: T
  The value.
Returns default
Throws
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:99

isLessThanOrEqualTo

isLessThanOrEqualTo<T>(value): default
Ensures the string is less than or equal to the specified value.
Type Parameters
- T extends IComparable
Parameters
- value: T
  The value.
Returns default
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:85

isNotEmpty

isNotEmpty(): default
Ensures the string is not empty

Returns default
Throws
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:41

isNotNull

isNotNull(): default
Ensures the argument is not null

Returns default
Inherited from default.isNotNull
- Defined in src/Assertions/ArgumentAssertionBuilder.ts:37

isNotNullOrUndefined

isNotNullOrUndefined(): default
Ensures the argument is not null or undefined

Returns default
Inherited from default.isNotNullOrUndefined
- Defined in src/Assertions/ArgumentAssertionBuilder.ts:31

isNotNullOrUndefinedOrEmpty

isNotNullOrUndefinedOrEmpty(): default
Ensures the string is not null, undefined or empty

Returns default
Throws
Throws
Throws
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:20

isNotUndefined

isNotUndefined(): default
Ensures the argument is not undefined

Returns default
Inherited from default.isNotUndefined
- Defined in src/Assertions/ArgumentAssertionBuilder.ts:47

isOneOf

isOneOf(...options): default
Determines whether the argument is one of the specified options.
Parameters
- Rest ...options: string[]
Returns default
Inherited from default.isOneOf
- Defined in src/Assertions/ArgumentAssertionBuilder.ts:99

isTypeOf

isTypeOf<T2>(type): default
Ensures the argument is of the type
Type Parameters
- T2
Parameters
- type: ConstructorFor<T2>
  The type
Returns default
Inherited from default.isTypeOf
- Defined in src/Assertions/ArgumentAssertionBuilder.ts:60

matches

matches(predicate, message?): default
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: string
  The message to use if the assertion is invalid.
Returns default
Inherited from default.matches
- Defined in src/Assertions/ArgumentAssertionBuilder.ts:74

matchesRegex

matchesRegex(regex): default
Ensures the string matches the specified regex.
Parameters
- regex: RegExp
  The regex.
Returns default
Throws
- Defined in src/Assertions/StringArgumentAssertionBuilder.ts:55

Generated using TypeDoc