UNPKG

@barchart/common-js

Version:

Library of common JavaScript utilities

github.com/barchart/barchart-common-js

barchart/barchart-common-js

72 lines (71 loc) • 3.23 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
71
72
/** * Utilities checking arguments. * * @public * @module lang/assert */ /** * Throws an error if an argument doesn't conform to the desired specification (as * determined by a type check). * * @static * @param {*} variable - The value to check. * @param {string=} variableName - The name of the value (used for formatting an error message). * @param {*=} type - The expected type of the argument. * @param {string=} typeDescription - The description of the expected type (used for formatting an error message). */ export function argumentIsRequired(variable: any, variableName?: string | undefined, type?: any | undefined, typeDescription?: string | undefined): void; /** * A relaxed version of the "argumentIsRequired" function that will not throw if * the value is undefined or null. * * @static * @param {*} variable - The value to check. * @param {string=} variableName - The name of the value (used for formatting an error message). * @param {*=} type - The expected type of the argument. * @param {string=} typeDescription - The description of the expected type (used for formatting an error message). * @param {Function=} predicate - A function used to validate the item (beyond type checking). * @param {string=} predicateDescription - A description of the assertion made by the predicate (e.g. "is an integer") that is used for formatting an error message. */ export function argumentIsOptional(variable: any, variableName?: string | undefined, type?: any | undefined, typeDescription?: string | undefined, predicate?: Function | undefined, predicateDescription?: string | undefined): void; /** * Throws an error when a value is not an array or its items do not satisfy the supplied constraint. * * @public * @param {*} variable * @param {*} variableName * @param {*} itemConstraint * @param {*} itemConstraintDescription */ export function argumentIsArray(variable: any, variableName: any, itemConstraint: any, itemConstraintDescription: any): void; /** * Throws an error if an argument doesn't conform to the desired specification * (as determined by a predicate). * * @static * @param {*} variable - The value to check. * @param {string=} variableName - The name of the value (used for formatting an error message). * @param {Function=} predicate - A function used to validate the item (beyond type checking). * @param {string=} predicateDescription - A description of the assertion made by the predicate (e.g. "is an integer") that is used for formatting an error message. */ export function argumentIsValid(variable: any, variableName?: string | undefined, predicate?: Function | undefined, predicateDescription?: string | undefined): void; /** * Throws an error when two values are not strictly equal. * * @public * @param {*} a * @param {*} b * @param {*=} descriptionA * @param {*=} descriptionB */ export function areEqual(a: any, b: any, descriptionA?: any | undefined, descriptionB?: any | undefined): void; /** * Throws an error when two values are strictly equal. * * @public * @param {*} a * @param {*} b * @param {*} descriptionA * @param {*} descriptionB */ export function areNotEqual(a: any, b: any, descriptionA: any, descriptionB: any): void;