UNPKG

@cowwoc/requirements

Version:

A fluent API for enforcing design contracts with automatic message generation.

github.com/cowwoc/requirements.js

cowwoc/requirements.js

70 lines (69 loc) • 3.02 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
import { MessageBuilder, AbstractValidator } from "../internal.mjs"; /** * @param validator - the validator * @returns a message for the validation failure */ declare function stringIsBlank(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @returns a message for the validation failure */ declare function stringIsNotBlank(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @returns a message for the validation failure */ declare function stringIsTrimmed(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @returns a message for the validation failure */ declare function stringIsStripped(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @param prefix - the value that the string must start with * @returns a message for the validation failure */ declare function stringStartsWith(validator: AbstractValidator<unknown>, prefix: string): MessageBuilder; /** * @param validator - the validator * @param prefix - the value that the string must start with * @returns a message for the validation failure */ declare function stringDoesNotStartWith(validator: AbstractValidator<unknown>, prefix: string): MessageBuilder; /** * @param validator - the validator * @param suffix - the value that the string must end with * @returns a message for the validation failure */ declare function stringEndsWith(validator: AbstractValidator<unknown>, suffix: string): MessageBuilder; /** * @param validator - the validator * @param suffix - the value that the string must end with * @returns a message for the validation failure */ declare function stringDoesNotEndWith(validator: AbstractValidator<unknown>, suffix: string): MessageBuilder; /** * @param validator - the validator * @param expected - the expected value * @returns a message for the validation failure */ declare function stringContains(validator: AbstractValidator<unknown>, expected: string): MessageBuilder; /** * @param validator - the validator * @param unwanted - the unwanted value * @returns a message for the validation failure */ declare function stringDoesNotContain(validator: AbstractValidator<unknown>, unwanted: string): MessageBuilder; /** * @param validator - the validator * @returns a message for the validation failure */ declare function stringDoesNotContainWhitespace(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @param regex - the regular expression * @returns a message for the validation failure */ declare function stringMatches(validator: AbstractValidator<unknown>, regex: string): MessageBuilder; export { stringIsBlank, stringIsNotBlank, stringIsTrimmed, stringIsStripped, stringStartsWith, stringDoesNotStartWith, stringEndsWith, stringDoesNotEndWith, stringContains, stringDoesNotContain, stringDoesNotContainWhitespace, stringMatches };