UNPKG

@cowwoc/requirements

Version:

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

github.com/cowwoc/requirements.js

cowwoc/requirements.js

60 lines (59 loc) • 2.63 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
import { AbstractValidator, MessageBuilder, Type } from "../internal.mjs"; /** * The minimum length of a value that triggers a diff. */ declare const MINIMUM_LENGTH_FOR_DIFF = 10; /** * @param validator - the validator * @returns a message for the validation failure */ declare function messagesIsUndefined(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @returns a message for the validation failure */ declare function messagesIsNotUndefined(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @returns a message for the validation failure */ declare function messagesIsNull(validator: AbstractValidator<unknown>): MessageBuilder; /** * @param validator - the validator * @returns a message for the validation failure */ declare function messagesIsNotNull(validator: AbstractValidator<unknown>): MessageBuilder; /** * @typeParam T - the type of the value * @param validator - the validator * @param constraint - the constraint that the value must adhere to (e.g. "must be negative") * @returns a message for the validation failure */ declare function messagesConstraint<T>(validator: AbstractValidator<T>, constraint: string): MessageBuilder; /** * @param validator - the validator * @param expectedName - the name of the expected value * @param expected - the expected value * @returns a message for the validation failure */ declare function messagesIsEqualTo(validator: AbstractValidator<unknown>, expectedName: string | null, expected: unknown): MessageBuilder; /** * @param validator - the validator * @param expected - the expected type * @returns a message for the validation failure */ declare function messagesIsInstanceOf(validator: AbstractValidator<unknown>, expected: Type): MessageBuilder; /** * @param validator - the validator * @param unwanted - the unwanted type * @returns a message for the validation failure */ declare function messagesIsNotInstanceOf(validator: AbstractValidator<unknown>, unwanted: Type): MessageBuilder; /** * @param validator - the validator * @param unwantedName - the name of the unwanted element * @param unwanted - the unwanted element * @returns a message for the validation failure */ declare function messagesIsNotEqualTo(validator: AbstractValidator<unknown>, unwantedName: string | null, unwanted: unknown): MessageBuilder; export { messagesIsUndefined, messagesIsNotUndefined, messagesIsNull, messagesIsNotNull, messagesConstraint, messagesIsEqualTo, messagesIsInstanceOf, messagesIsNotInstanceOf, messagesIsNotEqualTo, MINIMUM_LENGTH_FOR_DIFF };