@joookiwi/type 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/README.md +107 -0
  2. package/dist/boolean (false).d.ts +28 -0
  3. package/dist/boolean (false).d.ts.map +1 -0
  4. package/dist/boolean (true).d.ts +29 -0
  5. package/dist/boolean (true).d.ts.map +1 -0
  6. package/dist/boolean.d.ts +42 -0
  7. package/dist/boolean.d.ts.map +1 -0
  8. package/dist/empty.d.ts +51 -0
  9. package/dist/empty.d.ts.map +1 -0
  10. package/dist/index.d.ts +23 -0
  11. package/dist/index.d.ts.map +1 -0
  12. package/dist/mixed.d.ts +594 -0
  13. package/dist/mixed.d.ts.map +1 -0
  14. package/dist/nullable.d.ts +769 -0
  15. package/dist/nullable.d.ts.map +1 -0
  16. package/dist/numeric (-1).d.ts +86 -0
  17. package/dist/numeric (-1).d.ts.map +1 -0
  18. package/dist/numeric (0).d.ts +88 -0
  19. package/dist/numeric (0).d.ts.map +1 -0
  20. package/dist/numeric (1).d.ts +88 -0
  21. package/dist/numeric (1).d.ts.map +1 -0
  22. package/dist/numeric (2).d.ts +84 -0
  23. package/dist/numeric (2).d.ts.map +1 -0
  24. package/dist/numeric (bigint).d.ts +41 -0
  25. package/dist/numeric (bigint).d.ts.map +1 -0
  26. package/dist/numeric (number).d.ts +42 -0
  27. package/dist/numeric (number).d.ts.map +1 -0
  28. package/dist/numeric.d.ts +51 -0
  29. package/dist/numeric.d.ts.map +1 -0
  30. package/dist/string (individual).d.ts +33 -0
  31. package/dist/string (individual).d.ts.map +1 -0
  32. package/dist/string.d.ts +43 -0
  33. package/dist/string.d.ts.map +1 -0
  34. package/dist/symbol.d.ts +38 -0
  35. package/dist/symbol.d.ts.map +1 -0
  36. package/package.json +65 -0
  37. package/src/boolean (false).ts +30 -0
  38. package/src/boolean (true).ts +31 -0
  39. package/src/boolean.ts +45 -0
  40. package/src/empty.ts +57 -0
  41. package/src/index.ts +23 -0
  42. package/src/mixed.ts +642 -0
  43. package/src/nullable.ts +837 -0
  44. package/src/numeric (-1).ts +88 -0
  45. package/src/numeric (0).ts +90 -0
  46. package/src/numeric (1).ts +90 -0
  47. package/src/numeric (2).ts +86 -0
  48. package/src/numeric (bigint).ts +44 -0
  49. package/src/numeric (number).ts +45 -0
  50. package/src/numeric.ts +55 -0
  51. package/src/string (individual).ts +35 -0
  52. package/src/string.ts +59 -0
  53. package/src/symbol.ts +40 -0
@@ -0,0 +1,769 @@
1
+ /*******************************************************************************
2
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
3
+
4
+ This project is free to use.
5
+ All the right is reserved to the author of this project.
6
+ ******************************************************************************/
7
+ import type { Numeric } from "./numeric";
8
+ import type { Zero, ZeroBigInt, ZeroNumber } from "./numeric (0)";
9
+ import type { One, OneBigInt, OneNumber } from "./numeric (1)";
10
+ import type { Two, TwoBigInt, TwoNumber } from "./numeric (2)";
11
+ import type { MinusOne, MinusOneBigInt, MinusOneNumber } from "./numeric (-1)";
12
+ import type { JavascriptSymbol, TypescriptSymbol } from "./symbol";
13
+ /** A type-alias for <b>null</b> or <b>undefined</b> */
14
+ export type NullOrUndefined = null | undefined;
15
+ /**
16
+ * A type-alias for <b>null</b> in a {@link String} template
17
+ *
18
+ * @see Template
19
+ * @see NullableTemplate
20
+ */
21
+ export type NullTemplate<T extends null = null> = `${T}`;
22
+ /**
23
+ * A type-alias for <b>undefined</b> in a {@link String} template
24
+ *
25
+ * @see Template
26
+ * @see NullableTemplate
27
+ */
28
+ export type UndefinedTemplate<T extends undefined = undefined> = `${T}`;
29
+ /**
30
+ * A type-alias for <b>null</b> or <b>undefined</b> in a {@link String} template
31
+ *
32
+ * @see Template
33
+ * @see NullTemplate
34
+ * @see UndefinedTemplate
35
+ */
36
+ export type NullableTemplate<T extends NullOrUndefined = NullOrUndefined> = `${T}`;
37
+ /**
38
+ * A type-alias of a value or <b>null</b>
39
+ *
40
+ * @see Nullable
41
+ */
42
+ export type NullOr<T> = T | null;
43
+ /**
44
+ * A type-alias of a value or <b>undefined</b>
45
+ *
46
+ * @see Nullable
47
+ */
48
+ export type UndefinedOr<T> = T | undefined;
49
+ /**
50
+ * A type-alias of a value, <b>null</b> or <b>undefined</b>
51
+ *
52
+ * @see NullOr
53
+ * @see UndefinedOr
54
+ */
55
+ export type Nullable<T> = T | null | undefined;
56
+ /**
57
+ * A type-alias for a {@link Boolean} or <b>undefined</b>
58
+ *
59
+ * @see UndefinedOr
60
+ * @see UndefinedOrTrue
61
+ * @see UndefinedOrFalse
62
+ * @see NullableBoolean
63
+ */
64
+ export type UndefinedOrBoolean<T extends boolean = boolean> = T | undefined;
65
+ /**
66
+ * A type-alias for a {@link Boolean} or <b>null</b>
67
+ *
68
+ * @see NullOr
69
+ * @see NullOrTrue
70
+ * @see NullOrFalse
71
+ * @see NullableBoolean
72
+ */
73
+ export type NullOrBoolean<T extends boolean = boolean> = T | null;
74
+ /**
75
+ * A type-alias for a {@link Boolean}, <b>null</b> or <b>undefined</b>
76
+ *
77
+ * @see Nullable
78
+ * @see NullableTrue
79
+ * @see NullableFalse
80
+ * @see UndefinedOrBoolean
81
+ * @see NullOrBoolean
82
+ */
83
+ export type NullableBoolean<T extends boolean = boolean> = T | null | undefined;
84
+ /**
85
+ * A type-alias for as <b>true</b> or <b>undefined</b>
86
+ *
87
+ * @see UndefinedOr
88
+ * @see UndefinedOrBoolean
89
+ * @see NullableTrue
90
+ */
91
+ export type UndefinedOrTrue<T extends true = true> = T | undefined;
92
+ /**
93
+ * A type-alias for <b>true</b> or <b>null</b>
94
+ *
95
+ * @see NullOr
96
+ * @see NullOrBoolean
97
+ * @see NullableTrue
98
+ */
99
+ export type NullOrTrue<T extends true = true> = T | null;
100
+ /**
101
+ * A type-alias for <b>true</b>, <b>null</b> or <b>undefined</b>
102
+ *
103
+ * @see Nullable
104
+ * @see NullableBoolean
105
+ * @see UndefinedOrTrue
106
+ * @see NullOrTrue
107
+ */
108
+ export type NullableTrue<T extends true = true> = T | null | undefined;
109
+ /**
110
+ * A type-alias for <b>false</b> or <b>undefined</b>
111
+ *
112
+ * @see UndefinedOr
113
+ * @see UndefinedOrBoolean
114
+ * @see NullableFalse
115
+ */
116
+ export type UndefinedOrFalse<T extends false = false> = T | undefined;
117
+ /**
118
+ * A type-alias for <b>false</b> or <b>null</b>
119
+ *
120
+ * @see NullOr
121
+ * @see NullOrBoolean
122
+ * @see NullableFalse
123
+ */
124
+ export type NullOrFalse<T extends false = false> = T | null;
125
+ /**
126
+ * A type-alias for <b>false</b>, <b>null</b> or <b>undefined</b>
127
+ *
128
+ * @see Nullable
129
+ * @see NullableBoolean
130
+ * @see UndefinedOrFalse
131
+ * @see NullOrFalse
132
+ */
133
+ export type NullableFalse<T extends false = false> = T | null | undefined;
134
+ /**
135
+ * A type-alias for a {@link String} or <b>undefined</b>
136
+ *
137
+ * @see UndefinedOr
138
+ * @see NullableString
139
+ */
140
+ export type UndefinedOrString<T extends string = string> = T | undefined;
141
+ /**
142
+ * A type-alias for a {@link String} or <b>null</b>
143
+ *
144
+ * @see NullOr
145
+ * @see NullableString
146
+ */
147
+ export type NullOrString<T extends string = string> = T | null;
148
+ /**
149
+ * A type-alias for a {@link String}, <b>null</b> or <b>undefined</b>
150
+ *
151
+ * @see Nullable
152
+ * @see UndefinedOrString
153
+ * @see NullOrString
154
+ */
155
+ export type NullableString<T extends string = string> = T | null | undefined;
156
+ /**
157
+ * A type-alias of a {@link Number} or <b>undefined</b>
158
+ *
159
+ * @see UndefinedOr
160
+ * @see UndefinedOrNumeric
161
+ * @see NullableNumber
162
+ */
163
+ export type UndefinedOrNumber<T extends number = number> = T | undefined;
164
+ /**
165
+ * A type-alias of a {@link Number} or <b>null</b>
166
+ *
167
+ * @see NullOr
168
+ * @see NullOrNumeric
169
+ * @see NullableNumber
170
+ */
171
+ export type NullOrNumber<T extends number = number> = T | null;
172
+ /**
173
+ * A type-alias of a {@link Number}, <b>null</b> or <b>undefined</b>
174
+ *
175
+ * @see Nullable
176
+ * @see NullableNumeric
177
+ * @see UndefinedOrNumber
178
+ * @see NullOrNumber
179
+ */
180
+ export type NullableNumber<T extends number = number> = T | null | undefined;
181
+ /**
182
+ * A type-alias of a {@link BigInt} or <b>undefined</b>
183
+ *
184
+ * @see UndefinedOr
185
+ * @see UndefinedOrNumeric
186
+ * @see NullableBigInt
187
+ */
188
+ export type UndefinedOrBigInt<T extends bigint = bigint> = T | undefined;
189
+ /**
190
+ * A type-alias of a {@link BigInt} or <b>null</b>
191
+ *
192
+ * @see NullOr
193
+ * @see NullOrNumeric
194
+ * @see NullableBigInt
195
+ */
196
+ export type NullOrBigInt<T extends bigint = bigint> = T | null;
197
+ /**
198
+ * A type-alias of a {@link BigInt}, <b>null</b> or <b>undefined</b>
199
+ *
200
+ * @see Nullable
201
+ * @see NullableNumeric
202
+ * @see UndefinedOrBigInt
203
+ * @see NullOrBigInt
204
+ */
205
+ export type NullableBigInt<T extends bigint = bigint> = T | null | undefined;
206
+ /**
207
+ * A type-alias of a value (as a {@link Number} or {@link BigInt}) or <b>undefined</b>
208
+ *
209
+ * @see UndefinedOr
210
+ * @see UndefinedOrNumber
211
+ * @see UndefinedOrBigInt
212
+ * @see NullableNumeric
213
+ */
214
+ export type UndefinedOrNumeric<T extends Numeric = Numeric> = T | undefined;
215
+ /**
216
+ * A type-alias of a value (as a {@link Number} or {@link BigInt}) or <b>null</b>
217
+ *
218
+ * @see NullOr
219
+ * @see NullOrNumber
220
+ * @see NullOrBigInt
221
+ * @see NullableNumeric
222
+ */
223
+ export type NullOrNumeric<T extends Numeric = Numeric> = T | null;
224
+ /**
225
+ * A type-alias of a value (as a {@link Number} or {@link BigInt}), <b>null</b> or <b>undefined</b>
226
+ *
227
+ * @see Nullable
228
+ * @see NullableNumber
229
+ * @see NullableBigInt
230
+ * @see UndefinedOrNumeric
231
+ * @see NullOrNumeric
232
+ */
233
+ export type NullableNumeric<T extends Numeric = Numeric> = T | null | undefined;
234
+ /**
235
+ * A type-alias of the value <b>-1</b> (as a {@link Number} or {@link BigInt})
236
+ * or <b>undefined</b>
237
+ *
238
+ * @see UndefinedOr
239
+ * @see UndefinedOrNumeric
240
+ * @see UndefinedOrMinusOneNumber
241
+ * @see UndefinedOrMinusOneBigInt
242
+ * @see NullableMinusOne
243
+ */
244
+ export type UndefinedOrMinusOne<T extends MinusOne = MinusOne> = T | undefined;
245
+ /**
246
+ * A type-alias of the {@link Number} <b>-1</b>
247
+ * or <b>undefined</b>
248
+ *
249
+ * @see UndefinedOr
250
+ * @see UndefinedOrNumeric
251
+ * @see UndefinedOrNumber
252
+ * @see UndefinedOrMinusOne
253
+ * @see NullableMinusOne
254
+ * @see NullableMinusOneNumber
255
+ */
256
+ export type UndefinedOrMinusOneNumber<T extends MinusOneNumber = MinusOneNumber> = T | undefined;
257
+ /**
258
+ * A type-alias of the {@link BigInt} <b>-1</b>
259
+ * or <b>undefined</b>
260
+ *
261
+ * @see UndefinedOr
262
+ * @see UndefinedOrNumeric
263
+ * @see UndefinedOrBigInt
264
+ * @see UndefinedOrMinusOne
265
+ * @see NullableMinusOne
266
+ * @see NullableMinusOneBigInt
267
+ */
268
+ export type UndefinedOrMinusOneBigInt<T extends MinusOneBigInt = MinusOneBigInt> = T | undefined;
269
+ /**
270
+ * A type-alias of a value (as a {@link Number} or {@link BigInt})
271
+ * or <b>null</b>
272
+ *
273
+ * @see NullOr
274
+ * @see NullOrNumeric
275
+ * @see NullOrMinusOneNumber
276
+ * @see NullOrMinusOneBigInt
277
+ * @see NullableMinusOne
278
+ */
279
+ export type NullOrMinusOne<T extends MinusOne = MinusOne> = T | null;
280
+ /**
281
+ * A type-alias of the {@link Number} <b>-1</b>
282
+ * or <b>null</b>
283
+ *
284
+ * @see NullOr
285
+ * @see NullOrNumeric
286
+ * @see NullOrNumber
287
+ * @see NullOrMinusOne
288
+ * @see NullableMinusOne
289
+ * @see NullableMinusOneNumber
290
+ */
291
+ export type NullOrMinusOneNumber<T extends MinusOneNumber = MinusOneNumber> = T | null;
292
+ /**
293
+ * A type-alias of the {@link BigInt} <b>-1</b>
294
+ * or <b>null</b>
295
+ *
296
+ * @see NullOr
297
+ * @see NullOrNumeric
298
+ * @see NullOrBigInt
299
+ * @see NullOrMinusOne
300
+ * @see NullableMinusOne
301
+ * @see NullableMinusOneBigInt
302
+ */
303
+ export type NullOrMinusOneBigInt<T extends MinusOneBigInt = MinusOneBigInt> = T | null;
304
+ /**
305
+ * A type-alias of the value <b>-1</b> (as a {@link Number} or {@link BigInt}),
306
+ * <b>null</b> or <b>undefined</b>
307
+ *
308
+ * @see Nullable
309
+ * @see NullableNumeric
310
+ * @see NullableMinusOneNumber
311
+ * @see NullableMinusOneBigInt
312
+ * @see UndefinedOrMinusOne
313
+ * @see NullOrMinusOne
314
+ */
315
+ export type NullableMinusOne<T extends MinusOne = MinusOne> = T | null | undefined;
316
+ /**
317
+ * A type-alias of the {@link Number} <b>-1</b>,
318
+ * <b>null</b> or <b>undefined</b>
319
+ *
320
+ * @see Nullable
321
+ * @see NullableNumeric
322
+ * @see NullableNumber
323
+ * @see NullableMinusOne
324
+ * @see UndefinedOrMinusOne
325
+ * @see UndefinedOrMinusOneNumber
326
+ * @see NullOrMinusOne
327
+ * @see NullOrMinusOneNumber
328
+ */
329
+ export type NullableMinusOneNumber<T extends MinusOneNumber = MinusOneNumber> = T | null | undefined;
330
+ /**
331
+ * A type-alias of the {@link BigInt} <b>-1</b>,
332
+ * <b>null</b> or <b>undefined</b>
333
+ *
334
+ * @see Nullable
335
+ * @see NullableNumeric
336
+ * @see NullableBigInt
337
+ * @see NullableMinusOne
338
+ * @see UndefinedOrMinusOne
339
+ * @see UndefinedOrMinusOneBigInt
340
+ * @see NullOrMinusOne
341
+ * @see NullOrMinusOneBigInt
342
+ */
343
+ export type NullableMinusOneBigInt<T extends MinusOneBigInt = MinusOneBigInt> = T | null | undefined;
344
+ /**
345
+ * A type-alias of the value <b>0</b> (as a {@link Number} or {@link BigInt})
346
+ * or <b>undefined</b>
347
+ *
348
+ * @see UndefinedOr
349
+ * @see UndefinedOrNumeric
350
+ * @see UndefinedOrZeroNumber
351
+ * @see UndefinedOrZeroBigInt
352
+ * @see NullableZero
353
+ */
354
+ export type UndefinedOrZero<T extends Zero = Zero> = T | undefined;
355
+ /**
356
+ * A type-alias of the {@link Number} <b>0</b>
357
+ * or <b>undefined</b>
358
+ *
359
+ * @see UndefinedOr
360
+ * @see UndefinedOrNumeric
361
+ * @see UndefinedOrNumber
362
+ * @see UndefinedOrZero
363
+ * @see NullableZero
364
+ * @see NullableZeroNumber
365
+ */
366
+ export type UndefinedOrZeroNumber<T extends ZeroNumber = ZeroNumber> = T | undefined;
367
+ /**
368
+ * A type-alias of the {@link BigInt} <b>0</b>
369
+ * or <b>undefined</b>
370
+ *
371
+ * @see UndefinedOr
372
+ * @see UndefinedOrNumeric
373
+ * @see UndefinedOrBigInt
374
+ * @see UndefinedOrZero
375
+ * @see NullableZero
376
+ * @see NullableZeroBigInt
377
+ */
378
+ export type UndefinedOrZeroBigInt<T extends ZeroBigInt = ZeroBigInt> = T | undefined;
379
+ /**
380
+ * A type-alias of a value (as a {@link Number} or {@link BigInt})
381
+ * or <b>null</b>
382
+ *
383
+ * @see NullOr
384
+ * @see NullOrNumeric
385
+ * @see NullOrZeroNumber
386
+ * @see NullOrZeroBigInt
387
+ * @see NullableZero
388
+ */
389
+ export type NullOrZero<T extends Zero = Zero> = T | null;
390
+ /**
391
+ * A type-alias of the {@link Number} <b>0</b>
392
+ * or <b>null</b>
393
+ *
394
+ * @see NullOr
395
+ * @see NullOrNumeric
396
+ * @see NullOrNumber
397
+ * @see NullOrZero
398
+ * @see NullableZero
399
+ * @see NullableZeroNumber
400
+ */
401
+ export type NullOrZeroNumber<T extends ZeroNumber = ZeroNumber> = T | null;
402
+ /**
403
+ * A type-alias of the {@link BigInt} <b>0</b>
404
+ * or <b>null</b>
405
+ *
406
+ * @see NullOr
407
+ * @see NullOrNumeric
408
+ * @see NullOrBigInt
409
+ * @see NullOrZero
410
+ * @see NullableZero
411
+ * @see NullableZeroBigInt
412
+ */
413
+ export type NullOrZeroBigInt<T extends ZeroBigInt = ZeroBigInt> = T | null;
414
+ /**
415
+ * A type-alias of the value <b>0</b> (as a {@link Number} or {@link BigInt}),
416
+ * <b>null</b> or <b>undefined</b>
417
+ *
418
+ * @see Nullable
419
+ * @see NullableNumeric
420
+ * @see NullableZeroNumber
421
+ * @see NullableZeroBigInt
422
+ * @see UndefinedOrZero
423
+ * @see NullOrZero
424
+ */
425
+ export type NullableZero<T extends Zero = Zero> = T | null | undefined;
426
+ /**
427
+ * A type-alias of the {@link Number} <b>0</b>,
428
+ * <b>null</b> or <b>undefined</b>
429
+ *
430
+ * @see Nullable
431
+ * @see NullableNumeric
432
+ * @see NullableNumber
433
+ * @see NullableZero
434
+ * @see UndefinedOrZero
435
+ * @see UndefinedOrZeroNumber
436
+ * @see NullOrZero
437
+ * @see NullOrZeroNumber
438
+ */
439
+ export type NullableZeroNumber<T extends ZeroNumber = ZeroNumber> = T | null | undefined;
440
+ /**
441
+ * A type-alias of the {@link BigInt} <b>0</b>,
442
+ * <b>null</b> or <b>undefined</b>
443
+ *
444
+ * @see Nullable
445
+ * @see NullableNumeric
446
+ * @see NullableBigInt
447
+ * @see NullableZero
448
+ * @see UndefinedOrZero
449
+ * @see UndefinedOrZeroBigInt
450
+ * @see NullOrZero
451
+ * @see NullOrZeroBigInt
452
+ */
453
+ export type NullableZeroBigInt<T extends ZeroBigInt = ZeroBigInt> = T | null | undefined;
454
+ /**
455
+ * A type-alias of the value <b>1</b> (as a {@link Number} or {@link BigInt})
456
+ * or <b>undefined</b>
457
+ *
458
+ * @see UndefinedOr
459
+ * @see UndefinedOrNumeric
460
+ * @see UndefinedOrOneNumber
461
+ * @see UndefinedOrOneBigInt
462
+ * @see NullableOne
463
+ */
464
+ export type UndefinedOrOne<T extends One = One> = T | undefined;
465
+ /**
466
+ * A type-alias of the {@link Number} <b>1</b>
467
+ * or <b>undefined</b>
468
+ *
469
+ * @see UndefinedOr
470
+ * @see UndefinedOrNumeric
471
+ * @see UndefinedOrNumber
472
+ * @see UndefinedOrOne
473
+ * @see NullableOne
474
+ * @see NullableOneNumber
475
+ */
476
+ export type UndefinedOrOneNumber<T extends OneNumber = OneNumber> = T | undefined;
477
+ /**
478
+ * A type-alias of the {@link BigInt} <b>1</b>
479
+ * or <b>undefined</b>
480
+ *
481
+ * @see UndefinedOr
482
+ * @see UndefinedOrNumeric
483
+ * @see UndefinedOrBigInt
484
+ * @see UndefinedOrOne
485
+ * @see NullableOne
486
+ * @see NullableOneBigInt
487
+ */
488
+ export type UndefinedOrOneBigInt<T extends OneBigInt = OneBigInt> = T | undefined;
489
+ /**
490
+ * A type-alias of a value (as a {@link Number} or {@link BigInt})
491
+ * or <b>null</b>
492
+ *
493
+ * @see NullOr
494
+ * @see NullOrNumeric
495
+ * @see NullOrOneNumber
496
+ * @see NullOrOneBigInt
497
+ * @see NullableOne
498
+ */
499
+ export type NullOrOne<T extends One = One> = T | null;
500
+ /**
501
+ * A type-alias of the {@link Number} <b>1</b>
502
+ * or <b>null</b>
503
+ *
504
+ * @see NullOr
505
+ * @see NullOrNumeric
506
+ * @see NullOrNumber
507
+ * @see NullOrOne
508
+ * @see NullableOne
509
+ * @see NullableOneNumber
510
+ */
511
+ export type NullOrOneNumber<T extends OneNumber = OneNumber> = T | null;
512
+ /**
513
+ * A type-alias of the {@link BigInt} <b>1</b>
514
+ * or <b>null</b>
515
+ *
516
+ * @see NullOr
517
+ * @see NullOrNumeric
518
+ * @see NullOrBigInt
519
+ * @see NullOrOne
520
+ * @see NullableOne
521
+ * @see NullableOneBigInt
522
+ */
523
+ export type NullOrOneBigInt<T extends OneBigInt = OneBigInt> = T | null;
524
+ /**
525
+ * A type-alias of the value <b>1</b> (as a {@link Number} or {@link BigInt}),
526
+ * <b>null</b> or <b>undefined</b>
527
+ *
528
+ * @see Nullable
529
+ * @see NullableNumeric
530
+ * @see NullableOneNumber
531
+ * @see NullableOneBigInt
532
+ * @see UndefinedOrOne
533
+ * @see NullOrOne
534
+ */
535
+ export type NullableOne<T extends One = One> = T | null | undefined;
536
+ /**
537
+ * A type-alias of the {@link Number} <b>1</b>,
538
+ * <b>null</b> or <b>undefined</b>
539
+ *
540
+ * @see Nullable
541
+ * @see NullableNumeric
542
+ * @see NullableNumber
543
+ * @see NullableOne
544
+ * @see UndefinedOrOne
545
+ * @see UndefinedOrOneNumber
546
+ * @see NullOrOne
547
+ * @see NullOrOneNumber
548
+ */
549
+ export type NullableOneNumber<T extends OneNumber = OneNumber> = T | null | undefined;
550
+ /**
551
+ * A type-alias of the {@link BigInt} <b>1</b>,
552
+ * <b>null</b> or <b>undefined</b>
553
+ *
554
+ * @see Nullable
555
+ * @see NullableNumeric
556
+ * @see NullableBigInt
557
+ * @see NullableOne
558
+ * @see UndefinedOrOne
559
+ * @see UndefinedOrOneBigInt
560
+ * @see NullOrOne
561
+ * @see NullOrOneBigInt
562
+ */
563
+ export type NullableOneBigInt<T extends OneBigInt = OneBigInt> = T | null | undefined;
564
+ /**
565
+ * A type-alias of the value <b>2</b> (as a {@link Number} or {@link BigInt})
566
+ * or <b>undefined</b>
567
+ *
568
+ * @see UndefinedOr
569
+ * @see UndefinedOrNumeric
570
+ * @see UndefinedOrTwoNumber
571
+ * @see UndefinedOrTwoBigInt
572
+ * @see NullableTwo
573
+ */
574
+ export type UndefinedOrTwo<T extends Two = Two> = T | undefined;
575
+ /**
576
+ * A type-alias of the {@link Number} <b>2</b>
577
+ * or <b>undefined</b>
578
+ *
579
+ * @see UndefinedOr
580
+ * @see UndefinedOrNumeric
581
+ * @see UndefinedOrNumber
582
+ * @see UndefinedOrTwo
583
+ * @see NullableTwo
584
+ * @see NullableTwoNumber
585
+ */
586
+ export type UndefinedOrTwoNumber<T extends TwoNumber = TwoNumber> = T | undefined;
587
+ /**
588
+ * A type-alias of the {@link BigInt} <b>2</b>
589
+ * or <b>undefined</b>
590
+ *
591
+ * @see UndefinedOr
592
+ * @see UndefinedOrNumeric
593
+ * @see UndefinedOrBigInt
594
+ * @see UndefinedOrTwo
595
+ * @see NullableTwo
596
+ * @see NullableTwoBigInt
597
+ */
598
+ export type UndefinedOrTwoBigInt<T extends TwoBigInt = TwoBigInt> = T | undefined;
599
+ /**
600
+ * A type-alias of a value (as a {@link Number} or {@link BigInt})
601
+ * or <b>null</b>
602
+ *
603
+ * @see NullOr
604
+ * @see NullOrNumeric
605
+ * @see NullOrTwoNumber
606
+ * @see NullOrTwoBigInt
607
+ * @see NullableTwo
608
+ */
609
+ export type NullOrTwo<T extends Two = Two> = T | null;
610
+ /**
611
+ * A type-alias of the {@link Number} <b>2</b>
612
+ * or <b>null</b>
613
+ *
614
+ * @see NullOr
615
+ * @see NullOrNumeric
616
+ * @see NullOrNumber
617
+ * @see NullOrTwo
618
+ * @see NullableTwo
619
+ * @see NullableTwoNumber
620
+ */
621
+ export type NullOrTwoNumber<T extends TwoNumber = TwoNumber> = T | null;
622
+ /**
623
+ * A type-alias of the {@link BigInt} <b>2</b>
624
+ * or <b>null</b>
625
+ *
626
+ * @see NullOr
627
+ * @see NullOrNumeric
628
+ * @see NullOrBigInt
629
+ * @see NullOrTwo
630
+ * @see NullableTwo
631
+ * @see NullableTwoBigInt
632
+ */
633
+ export type NullOrTwoBigInt<T extends TwoBigInt = TwoBigInt> = T | null;
634
+ /**
635
+ * A type-alias of the value <b>2</b> (as a {@link Number} or {@link BigInt}),
636
+ * <b>null</b> or <b>undefined</b>
637
+ *
638
+ * @see Nullable
639
+ * @see NullableNumeric
640
+ * @see NullableTwoNumber
641
+ * @see NullableTwoBigInt
642
+ * @see UndefinedOrTwo
643
+ * @see NullOrTwo
644
+ */
645
+ export type NullableTwo<T extends Two = Two> = T | null | undefined;
646
+ /**
647
+ * A type-alias of the {@link Number} <b>2</b>,
648
+ * <b>null</b> or <b>undefined</b>
649
+ *
650
+ * @see Nullable
651
+ * @see NullableNumeric
652
+ * @see NullableNumber
653
+ * @see NullableTwo
654
+ * @see UndefinedOrTwo
655
+ * @see UndefinedOrTwoNumber
656
+ * @see NullOrTwo
657
+ * @see NullOrTwoNumber
658
+ */
659
+ export type NullableTwoNumber<T extends TwoNumber = TwoNumber> = T | null | undefined;
660
+ /**
661
+ * A type-alias of the {@link BigInt} <b>2</b>,
662
+ * <b>null</b> or <b>undefined</b>
663
+ *
664
+ * @see Nullable
665
+ * @see NullableNumeric
666
+ * @see NullableBigInt
667
+ * @see NullableTwo
668
+ * @see UndefinedOrTwo
669
+ * @see UndefinedOrTwoBigInt
670
+ * @see NullOrTwo
671
+ * @see NullOrTwoBigInt
672
+ */
673
+ export type NullableTwoBigInt<T extends TwoBigInt = TwoBigInt> = T | null | undefined;
674
+ /**
675
+ * A type-alias for a {@link Symbol}
676
+ * or <b>undefined</b>
677
+ *
678
+ * @see UndefinedOr
679
+ * @see UndefinedOrJavascriptSymbol
680
+ * @see UndefinedOrTypescriptSymbol
681
+ * @see NullableSymbol
682
+ */
683
+ export type UndefinedOrSymbol<T extends symbol = symbol> = T | undefined;
684
+ /**
685
+ * A type-alias for an official Javascript {@link Symbol}
686
+ * or <b>undefined</b>
687
+ *
688
+ * @see UndefinedOr
689
+ * @see UndefinedOrSymbol
690
+ * @see JavascriptSymbol
691
+ * @see NullableSymbol
692
+ */
693
+ export type UndefinedOrJavascriptSymbol<T extends JavascriptSymbol = JavascriptSymbol> = T | undefined;
694
+ /**
695
+ * A type-alias for an official Typescript {@link Symbol}
696
+ * or <b>undefined</b>
697
+ *
698
+ * @see UndefinedOr
699
+ * @see UndefinedOrSymbol
700
+ * @see TypescriptSymbol
701
+ * @see NullableSymbol
702
+ */
703
+ export type UndefinedOrTypescriptSymbol<T extends TypescriptSymbol = TypescriptSymbol> = T | undefined;
704
+ /**
705
+ * A type-alias for a {@link Symbol}
706
+ * or <b>null</b>
707
+ *
708
+ * @see NullOr
709
+ * @see NullOrJavascriptSymbol
710
+ * @see NullOrTypescriptSymbol
711
+ * @see NullableSymbol
712
+ */
713
+ export type NullOrSymbol<T extends symbol = symbol> = T | null;
714
+ /**
715
+ * A type-alias for an official Javascript {@link Symbol}
716
+ * or <b>null</b>
717
+ *
718
+ * @see NullOr
719
+ * @see NullOrSymbol
720
+ * @see JavascriptSymbol
721
+ * @see NullableSymbol
722
+ */
723
+ export type NullOrJavascriptSymbol<T extends JavascriptSymbol = JavascriptSymbol> = T | null;
724
+ /**
725
+ * A type-alias for an official Typescript {@link Symbol}
726
+ * or <b>null</b>
727
+ *
728
+ * @see NullOr
729
+ * @see NullOrSymbol
730
+ * @see TypescriptSymbol
731
+ * @see NullableSymbol
732
+ */
733
+ export type NullOrTypescriptSymbol<T extends TypescriptSymbol = TypescriptSymbol> = T | undefined;
734
+ /**
735
+ * A type-alias for a {@link Symbol},
736
+ * <b>null</b> or <b>undefined</b>
737
+ *
738
+ * @see Nullable
739
+ * @see NullableJavascriptSymbol
740
+ * @see NullableTypescriptSymbol
741
+ * @see UndefinedOrSymbol
742
+ * @see NullOrSymbol
743
+ */
744
+ export type NullableSymbol<T extends symbol = symbol> = T | null | undefined;
745
+ /**
746
+ * A type-alias for an official Javascript {@link Symbol},
747
+ * <b>null</b> or <b>undefined</b>
748
+ *
749
+ * @see Nullable
750
+ * @see JavascriptSymbol
751
+ * @see UndefinedOrSymbol
752
+ * @see UndefinedOrJavascriptSymbol
753
+ * @see NullOrSymbol
754
+ * @see NullOrJavascriptSymbol
755
+ */
756
+ export type NullableJavascriptSymbol<T extends JavascriptSymbol = JavascriptSymbol> = T | null | undefined;
757
+ /**
758
+ * A type-alias for an official Typescript {@link Symbol}
759
+ * <b>null</b> or <b>undefined</b>
760
+ *
761
+ * @see Nullable
762
+ * @see TypescriptSymbol
763
+ * @see UndefinedOrSymbol
764
+ * @see UndefinedOrTypescriptSymbol
765
+ * @see NullOrSymbol
766
+ * @see NullOrTypescriptSymbol
767
+ */
768
+ export type NullableTypescriptSymbol<T extends TypescriptSymbol = TypescriptSymbol> = T | undefined;
769
+ //# sourceMappingURL=nullable.d.ts.map