Interface StringValidator

Low-level validation of a string.

Hierarchy

Validator<string, StringLimits | void>
- StringValidator

Index

Methods

getExpectedValueDescription validate

Methods

getExpectedValueDescription

getExpectedValueDescription(limits: void | StringLimits): string
Gets the description of expected value according to the specified limits.
Parameters
- limits: void | StringLimits
Returns string

Inherited from Validator.getExpectedValueDescription

validate

validate(value: unknown, limits: void | StringLimits): string
Validates TResult value according to the specified limits.

Returns
The specified value if it is valid.

Throws
Error with explanatory message without actual value if it is invalid.
Parameters
- value: unknown
- limits: void | StringLimits
Returns string

Inherited from Validator.validate

Generated using TypeDoc