-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.d.ts
More file actions
370 lines (333 loc) · 8.79 KB
/
index.d.ts
File metadata and controls
370 lines (333 loc) · 8.79 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
/* Assert.js type declarations */
export default assert;
export enum assertionTypes {
FAIL = 0,
IS_TRUTHY = 1,
IS_FALSY = 2,
IS_EMPTY = 3,
IS_NOT_EMPTY = 4,
IS_DEFINED = 5,
IS_UNDEFINED = 6,
IS_BOOL = 7,
IS_NOT_BOOL = 8,
IS_NUMBER = 9,
IS_NOT_NUMBER = 10,
IS_FLOAT = 11,
IS_NOT_FLOAT = 12,
IS_NAN = 13,
IS_NOT_NAN = 14,
IS_STRING = 15,
IS_NOT_STRING = 16,
IS_ARRAY = 17,
IS_NOT_ARRAY = 18,
IS_FUNCTION = 19,
IS_NOT_FUNCTION = 20,
IS_SYMBOL = 21,
IS_NOT_SYMBOL = 22,
INSTANCE_OF = 23,
NOT_INSTANCE_OF = 24,
IS_TRUE = 25,
IS_NOT_TRUE = 26,
IS_FALSE = 27,
IS_NOT_FALSE = 28,
IS_NULL = 29,
IS_NOT_NULL = 30,
MATCH = 31,
}
/**
* Property holding status of assertions activity
* @type {boolean}
*/
export let enabled: boolean;
/**
* Disable assertions
*/
export function disable(): void;
/**
* Enable assertions
*/
export function enable(): void;
/**
* Basic assertion exception class
* It is used to be thrown when assertion failed
* You can precise discover assertion which caused error by type or id
* @extends Error
*/
export class AssertionException extends Error {
protected type: assertionTypes;
protected id: string;
/**
* Create AssertionException based on type, message and id
* @param {assertionTypes} type - Assertion type
* @param {string} message - Custom error message
* @param {string} id - Exception id
*/
constructor(type: assertionTypes, message: string, id: string);
/**
* Get type of exception
* @returns {assertionTypes}
*/
getType(): assertionTypes;
/**
* Get id of exception
* @returns {string}
*/
getId(): string;
}
/**
* Always throw AssertError
* @param message
* @param id
* @returns {void}
*/
export function fail(message?: string, id?: string): void;
/**
* Assert if given value is truthy
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isTruthy(value: any, message?: string, id?: string): void;
/**
* Assert if given value is falsy
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isFalsy(value: any, message?: string, id?: string): void;
/**
* Assert if given value is empty
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isEmpty(value: any, message?: string, id?: string): void;
/**
* Assert if given value is not empty
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isNotEmpty(value: any, message?: string, id?: string): void;
/**
* Check if provided value is defined (have type other than undefined)
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isDefined(value: any, message?: string, id?: string): void;
/**
* Check if provided value is undefined
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isUndefined(value: any, message?: string, id?: string): void;
/**
* Check if provided value is boolean
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isBool(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not boolean
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isNotBool(value: any, message?: string, id?: string): void;
/**
* Check if provided value is number
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNumber(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not number
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNotNumber(value: any, message?: string, id?: string): void;
/**
* Check if provided value is float (number with value after decimal point)
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isFloat(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not float (number with value after decimal point)
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNotFloat(value: any, message?: string, id?: string): void;
/**
* Check if provided value is Not a Number
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNaN(value: any, message?: string, id?: string): void;
/**
* Check if provided value is other than Not a Number
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNotNaN(value: any, message?: string, id?: string): void;
/**
* Check if provided value is string
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isString(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not string
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNotString(value: any, message?: string, id?: string): void;
/**
* Check if provided value is an array
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isArray(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not an array
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNotArray(value: any, message?: string, id?: string): void;
/**
* Check if provided value is function
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isFunction(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not function
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isNotFunction(value: any, message?: string, id?: string): void;
/**
* Check if provided value is Symbol
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isSymbol(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not an Symbol
* @param value
* @param {string} message
* @param {string} id
* @returns void
*/
export function isNotSymbol(value: any, message?: string, id?: string): void;
/**
* Check if provided value is an expected instance
* @param value
* @param {Function} expectedInstance
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isInstanceOf(value: any, expectedInstance: Function, message?: string, id?: string): void;
/**
* Check if provided value is not instance of excluded instance
* @param value
* @param {Function} excludedInstance
* @param {string} message
* @param {string} id
*/
export function isNotInstanceOf(value: any, excludedInstance: Function, message?: string, id?: string): void;
/**
* Check if provided value is true
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isTrue(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not true
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isNotTrue(value: any, message?: string, id?: string): void;
/**
* Check if provided value is false
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isFalse(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not false
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isNotFalse(value: any, message?: string, id?: string): void;
/**
* Check if provided value is null
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isNull(value: any, message?: string, id?: string): void;
/**
* Check if provided value is not null
* @param value
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function isNotNull(value: any, message?: string, id?: string): void;
/**
* Check if provided value match provided RegExp
* @param {string} value
* @param {RegExp} regExp
* @param {string} message
* @param {string} id
* @returns {void}
*/
export function match(value: string, regExp: RegExp, message?: string, id?: string): void;