@joookiwi/type 1.0.0 → 1.1.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 (55) hide show
  1. package/dist/boolean (false).d.ts +1 -2
  2. package/dist/boolean (false).d.ts.map +1 -1
  3. package/dist/boolean (true).d.ts +0 -2
  4. package/dist/boolean (true).d.ts.map +1 -1
  5. package/dist/collection (array).d.ts +65 -0
  6. package/dist/collection (array).d.ts.map +1 -0
  7. package/dist/collection (map).d.ts +792 -0
  8. package/dist/collection (map).d.ts.map +1 -0
  9. package/dist/collection (mutable array).d.ts +65 -0
  10. package/dist/collection (mutable array).d.ts.map +1 -0
  11. package/dist/collection (mutable map).d.ts +792 -0
  12. package/dist/collection (mutable map).d.ts.map +1 -0
  13. package/dist/collection (mutable set).d.ts +65 -0
  14. package/dist/collection (mutable set).d.ts.map +1 -0
  15. package/dist/collection (set).d.ts +65 -0
  16. package/dist/collection (set).d.ts.map +1 -0
  17. package/dist/collection.d.ts +243 -0
  18. package/dist/collection.d.ts.map +1 -0
  19. package/dist/empty.d.ts +50 -8
  20. package/dist/empty.d.ts.map +1 -1
  21. package/dist/index.d.ts +7 -0
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/nullable.d.ts +22 -0
  24. package/dist/nullable.d.ts.map +1 -1
  25. package/dist/numeric (-1).d.ts +0 -11
  26. package/dist/numeric (-1).d.ts.map +1 -1
  27. package/dist/numeric (0).d.ts +2 -13
  28. package/dist/numeric (0).d.ts.map +1 -1
  29. package/dist/numeric (1).d.ts +2 -13
  30. package/dist/numeric (1).d.ts.map +1 -1
  31. package/dist/numeric (2).d.ts +2 -13
  32. package/dist/numeric (2).d.ts.map +1 -1
  33. package/dist/numeric.d.ts +0 -4
  34. package/dist/numeric.d.ts.map +1 -1
  35. package/dist/string (individual).d.ts +4 -0
  36. package/dist/string (individual).d.ts.map +1 -1
  37. package/package.json +9 -6
  38. package/src/boolean (false).ts +1 -2
  39. package/src/boolean (true).ts +0 -2
  40. package/src/collection (array).ts +69 -0
  41. package/src/collection (map).ts +833 -0
  42. package/src/collection (mutable array).ts +70 -0
  43. package/src/collection (mutable map).ts +833 -0
  44. package/src/collection (mutable set).ts +69 -0
  45. package/src/collection (set).ts +69 -0
  46. package/src/collection.ts +246 -0
  47. package/src/empty.ts +50 -8
  48. package/src/index.ts +7 -0
  49. package/src/nullable.ts +26 -0
  50. package/src/numeric (-1).ts +0 -11
  51. package/src/numeric (0).ts +2 -13
  52. package/src/numeric (1).ts +2 -13
  53. package/src/numeric (2).ts +2 -13
  54. package/src/numeric.ts +0 -4
  55. package/src/string (individual).ts +4 -0
@@ -0,0 +1,69 @@
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
+
8
+ import type {Numeric} from "./numeric"
9
+ import type {JavascriptSymbol, TypescriptSymbol} from "./symbol"
10
+
11
+ /**
12
+ * A type-alias for an {@link ReadonlySet Set} of {@link Boolean}
13
+ *
14
+ * @see MutableSet
15
+ */
16
+ export type MutableBooleanSet<T extends boolean = boolean, > = Set<T>
17
+
18
+ /**
19
+ * A type-alias for an {@link ReadonlySet Set} of {@link Number} or {@link BigInt}
20
+ *
21
+ * @see MutableSet
22
+ * @see MutableNumberSet
23
+ * @see MutableBigIntSet
24
+ */
25
+ export type MutableNumericSet<T extends Numeric = Numeric, > = Set<T>
26
+ /**
27
+ * A type-alias for an {@link ReadonlySet Set} of {@link Number}
28
+ *
29
+ * @see MutableSet
30
+ * @see MutableNumericSet
31
+ */
32
+ export type MutableNumberSet<T extends number = number, > = Set<T>
33
+ /**
34
+ * A type-alias for an {@link ReadonlySet Set} of {@link BigInt}
35
+ *
36
+ * @see MutableSet
37
+ * @see MutableNumericSet
38
+ */
39
+ export type MutableBigIntSet<T extends bigint = bigint, > = Set<T>
40
+
41
+ /**
42
+ * A type-alias for an {@link ReadonlySet Set} of {@link String}
43
+ *
44
+ * @see MutableSet
45
+ */
46
+ export type MutableStringSet<T extends string = string, > = Set<T>
47
+
48
+ /**
49
+ * A type-alias for an {@link ReadonlySet Set} of {@link Symbol}
50
+ *
51
+ * @see MutableSet
52
+ * @see MutableJavascriptSymbolSet
53
+ * @see MutableTypescriptSymbolSet
54
+ */
55
+ export type MutableSymbolSet<T extends symbol = symbol, > = Set<T>
56
+ /**
57
+ * A type-alias for an {@link ReadonlySet Set} of the official Javascript {@link Symbol}
58
+ *
59
+ * @see MutableSet
60
+ * @see MutableSymbolSet
61
+ */
62
+ export type MutableJavascriptSymbolSet<T extends JavascriptSymbol = JavascriptSymbol, > = Set<T>
63
+ /**
64
+ * A type-alias for an {@link ReadonlySet Set} of the official Typescript {@link Symbol}
65
+ *
66
+ * @see MutableSet
67
+ * @see MutableSymbolSet
68
+ */
69
+ export type MutableTypescriptSymbolSet<T extends TypescriptSymbol = TypescriptSymbol, > = Set<T>
@@ -0,0 +1,69 @@
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
+
8
+ import type {JavascriptSymbol, TypescriptSymbol} from "./symbol"
9
+ import type {Numeric} from "./numeric"
10
+
11
+ /**
12
+ * A type-alias for an {@link ReadonlySet Set} of {@link Boolean}
13
+ *
14
+ * @see import('collection').Set
15
+ */
16
+ export type BooleanSet<T extends boolean = boolean, > = ReadonlySet<T>
17
+
18
+ /**
19
+ * A type-alias for an {@link ReadonlySet Set} of {@link Number} or {@link BigInt}
20
+ *
21
+ * @see import('collection').Set
22
+ * @see NumberSet
23
+ * @see BigIntSet
24
+ */
25
+ export type NumericSet<T extends Numeric = Numeric, > = ReadonlySet<T>
26
+ /**
27
+ * A type-alias for an {@link ReadonlySet Set} of {@link Number}
28
+ *
29
+ * @see import('collection').Set
30
+ * @see NumericSet
31
+ */
32
+ export type NumberSet<T extends number = number, > = ReadonlySet<T>
33
+ /**
34
+ * A type-alias for an {@link ReadonlySet Set} of {@link BigInt}
35
+ *
36
+ * @see import('collection').Set
37
+ * @see NumericSet
38
+ */
39
+ export type BigIntSet<T extends bigint = bigint, > = ReadonlySet<T>
40
+
41
+ /**
42
+ * A type-alias for an {@link ReadonlySet Set} of {@link String}
43
+ *
44
+ * @see import('collection').Set
45
+ */
46
+ export type StringSet<T extends string = string, > = ReadonlySet<T>
47
+
48
+ /**
49
+ * A type-alias for an {@link ReadonlySet Set} of {@link Symbol}
50
+ *
51
+ * @see import('collection').Set
52
+ * @see JavascriptSymbolSet
53
+ * @see TypescriptSymbolSet
54
+ */
55
+ export type SymbolSet<T extends symbol = symbol, > = ReadonlySet<T>
56
+ /**
57
+ * A type-alias for an {@link ReadonlySet Set} of the official Javascript {@link Symbol}
58
+ *
59
+ * @see import('collection').Set
60
+ * @see SymbolSet
61
+ */
62
+ export type JavascriptSymbolSet<T extends JavascriptSymbol = JavascriptSymbol, > = ReadonlySet<T>
63
+ /**
64
+ * A type-alias for an {@link ReadonlySet Set} of the official Typescript {@link Symbol}
65
+ *
66
+ * @see import('collection').Set
67
+ * @see SymbolSet
68
+ */
69
+ export type TypescriptSymbolSet<T extends TypescriptSymbol = TypescriptSymbol, > = ReadonlySet<T>
@@ -0,0 +1,246 @@
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
+
8
+ /**
9
+ * A type-alias for an {@link ReadonlyArray Array} of a value
10
+ *
11
+ * @see BooleanArray
12
+ * @see NumericArray
13
+ * @see NumberArray
14
+ * @see BigIntArray
15
+ * @see StringArray
16
+ * @see SymbolArray
17
+ * @see JavascriptSymbolArray
18
+ * @see TypescriptSymbolArray
19
+ */
20
+ export type Array<T, > = readonly T[]
21
+ /**
22
+ * A type-alias for a {@link globalThis.Array MutableArray} of a value
23
+ *
24
+ * @see MutableBooleanArray
25
+ * @see MutableNumericArray
26
+ * @see MutableNumberArray
27
+ * @see MutableBigIntArray
28
+ * @see MutableStringArray
29
+ * @see MutableSymbolArray
30
+ * @see MutableJavascriptSymbolArray
31
+ * @see MutableTypescriptSymbolArray
32
+ */
33
+ export type MutableArray<T, > = T[]
34
+
35
+ /**
36
+ * A type-alias for a {@link ReadonlySet Set} of a value
37
+ *
38
+ * @see BooleanSet
39
+ * @see NumericSet
40
+ * @see NumberSet
41
+ * @see BigIntSet
42
+ * @see StringSet
43
+ * @see SymbolSet
44
+ * @see JavascriptSymbolSet
45
+ * @see TypescriptSymbolSet
46
+ */
47
+ export type Set<T, > = ReadonlySet<T>
48
+ /**
49
+ * A type-alias for a {@link globalThis.Set MutableSet} of a value
50
+ *
51
+ * @see MutableBooleanSet
52
+ * @see MutableNumericSet
53
+ * @see MutableNumberSet
54
+ * @see MutableBigIntSet
55
+ * @see MutableStringSet
56
+ * @see MutableSymbolSet
57
+ * @see MutableJavascriptSymbolSet
58
+ * @see MutableTypescriptSymbolSet
59
+ */
60
+ export type MutableSet<T, > = globalThis.Set<T>
61
+
62
+ /**
63
+ * A type-alias for a {@link ReadonlyMap Map} of a key and a value
64
+ *
65
+ * @see BooleanKeyMap
66
+ * @see BooleanValueMap
67
+ * @see BooleanBooleanMap
68
+ * @see BooleanNumericMap
69
+ * @see BooleanNumberMap
70
+ * @see BooleanBigIntMap
71
+ * @see BooleanStringMap
72
+ * @see BooleanSymbolMap
73
+ * @see BooleanJavascriptSymbolMap
74
+ * @see BooleanTypescriptSymbolMap
75
+ *
76
+ * @see NumericKeyMap
77
+ * @see NumericValueMap
78
+ * @see NumericBooleanMap
79
+ * @see NumericNumericMap
80
+ * @see NumericNumberMap
81
+ * @see NumericBigIntMap
82
+ * @see NumericStringMap
83
+ * @see NumericSymbolMap
84
+ * @see NumericJavascriptSymbolMap
85
+ * @see NumericTypescriptSymbolMap
86
+ *
87
+ * @see NumberKeyMap
88
+ * @see NumberValueMap
89
+ * @see NumberBooleanMap
90
+ * @see NumberNumericMap
91
+ * @see NumberNumberMap
92
+ * @see NumberBigIntMap
93
+ * @see NumberStringMap
94
+ * @see NumberSymbolMap
95
+ * @see NumberJavascriptSymbolMap
96
+ * @see NumberTypescriptSymbolMap
97
+ *
98
+ * @see BigIntKeyMap
99
+ * @see BigIntValueMap
100
+ * @see BigIntBooleanMap
101
+ * @see BigIntNumericMap
102
+ * @see BigIntNumberMap
103
+ * @see BigIntBigIntMap
104
+ * @see BigIntStringMap
105
+ * @see BigIntSymbolMap
106
+ * @see BigIntJavascriptSymbolMap
107
+ * @see BigIntTypescriptSymbolMap
108
+ *
109
+ * @see StringKeyMap
110
+ * @see StringValueMap
111
+ * @see StringBooleanMap
112
+ * @see StringNumericMap
113
+ * @see StringNumberMap
114
+ * @see StringBigIntMap
115
+ * @see StringStringMap
116
+ * @see StringSymbolMap
117
+ * @see StringJavascriptSymbolMap
118
+ * @see StringTypescriptSymbolMap
119
+ *
120
+ * @see SymbolKeyMap
121
+ * @see SymbolValueMap
122
+ * @see SymbolBooleanMap
123
+ * @see SymbolNumericMap
124
+ * @see SymbolNumberMap
125
+ * @see SymbolBigIntMap
126
+ * @see SymbolStringMap
127
+ * @see SymbolSymbolMap
128
+ * @see SymbolJavascriptSymbolMap
129
+ * @see SymbolTypescriptSymbolMap
130
+ *
131
+ * @see JavascriptSymbolKeyMap
132
+ * @see JavascriptSymbolValueMap
133
+ * @see JavascriptSymbolBooleanMap
134
+ * @see JavascriptSymbolNumericMap
135
+ * @see JavascriptSymbolNumberMap
136
+ * @see JavascriptSymbolBigIntMap
137
+ * @see JavascriptSymbolStringMap
138
+ * @see JavascriptSymbolSymbolMap
139
+ * @see JavascriptSymbolJavascriptSymbolMap
140
+ * @see JavascriptSymbolTypescriptSymbolMap
141
+ *
142
+ * @see TypescriptSymbolKeyMap
143
+ * @see TypescriptSymbolValueMap
144
+ * @see TypescriptSymbolBooleanMap
145
+ * @see TypescriptSymbolNumericMap
146
+ * @see TypescriptSymbolNumberMap
147
+ * @see TypescriptSymbolBigIntMap
148
+ * @see TypescriptSymbolStringMap
149
+ * @see TypescriptSymbolSymbolMap
150
+ * @see TypescriptSymbolJavascriptSymbolMap
151
+ * @see TypescriptSymbolTypescriptSymbolMap
152
+ */
153
+ export type Map<K, V, > = ReadonlyMap<K, V>
154
+
155
+ /**
156
+ * A type-alias for a {@link globalThis.Map MutableMap} of a key and a value
157
+ *
158
+ * @see MutableBooleanKeyMap
159
+ * @see MutableBooleanValueMap
160
+ * @see MutableBooleanBooleanMap
161
+ * @see MutableBooleanNumericMap
162
+ * @see MutableBooleanNumberMap
163
+ * @see MutableBooleanBigIntMap
164
+ * @see MutableBooleanStringMap
165
+ * @see MutableBooleanSymbolMap
166
+ * @see MutableBooleanJavascriptSymbolMap
167
+ * @see MutableBooleanTypescriptSymbolMap
168
+ *
169
+ * @see MutableNumericKeyMap
170
+ * @see MutableNumericValueMap
171
+ * @see MutableNumericBooleanMap
172
+ * @see MutableNumericNumericMap
173
+ * @see MutableNumericNumberMap
174
+ * @see MutableNumericBigIntMap
175
+ * @see MutableNumericStringMap
176
+ * @see MutableNumericSymbolMap
177
+ * @see MutableNumericJavascriptSymbolMap
178
+ * @see MutableNumericTypescriptSymbolMap
179
+ *
180
+ * @see MutableNumberKeyMap
181
+ * @see MutableNumberValueMap
182
+ * @see MutableNumberBooleanMap
183
+ * @see MutableNumberNumericMap
184
+ * @see MutableNumberNumberMap
185
+ * @see MutableNumberBigIntMap
186
+ * @see MutableNumberStringMap
187
+ * @see MutableNumberSymbolMap
188
+ * @see MutableNumberJavascriptSymbolMap
189
+ * @see MutableNumberTypescriptSymbolMap
190
+ *
191
+ * @see MutableBigIntKeyMap
192
+ * @see MutableBigIntValueMap
193
+ * @see MutableBigIntBooleanMap
194
+ * @see MutableBigIntNumericMap
195
+ * @see MutableBigIntNumberMap
196
+ * @see MutableBigIntBigIntMap
197
+ * @see MutableBigIntStringMap
198
+ * @see MutableBigIntSymbolMap
199
+ * @see MutableBigIntJavascriptSymbolMap
200
+ * @see MutableBigIntTypescriptSymbolMap
201
+ *
202
+ * @see MutableStringKeyMap
203
+ * @see MutableStringValueMap
204
+ * @see MutableStringBooleanMap
205
+ * @see MutableStringNumericMap
206
+ * @see MutableStringNumberMap
207
+ * @see MutableStringBigIntMap
208
+ * @see MutableStringStringMap
209
+ * @see MutableStringSymbolMap
210
+ * @see MutableStringJavascriptSymbolMap
211
+ * @see MutableStringTypescriptSymbolMap
212
+ *
213
+ * @see MutableSymbolKeyMap
214
+ * @see MutableSymbolValueMap
215
+ * @see MutableSymbolBooleanMap
216
+ * @see MutableSymbolNumericMap
217
+ * @see MutableSymbolNumberMap
218
+ * @see MutableSymbolBigIntMap
219
+ * @see MutableSymbolStringMap
220
+ * @see MutableSymbolSymbolMap
221
+ * @see MutableSymbolJavascriptSymbolMap
222
+ * @see MutableSymbolTypescriptSymbolMap
223
+ *
224
+ * @see MutableJavascriptSymbolKeyMap
225
+ * @see MutableJavascriptSymbolValueMap
226
+ * @see MutableJavascriptSymbolBooleanMap
227
+ * @see MutableJavascriptSymbolNumericMap
228
+ * @see MutableJavascriptSymbolNumberMap
229
+ * @see MutableJavascriptSymbolBigIntMap
230
+ * @see MutableJavascriptSymbolStringMap
231
+ * @see MutableJavascriptSymbolSymbolMap
232
+ * @see MutableJavascriptSymbolJavascriptSymbolMap
233
+ * @see MutableJavascriptSymbolTypescriptSymbolMap
234
+ *
235
+ * @see MutableTypescriptSymbolKeyMap
236
+ * @see MutableTypescriptSymbolValueMap
237
+ * @see MutableTypescriptSymbolBooleanMap
238
+ * @see MutableTypescriptSymbolNumericMap
239
+ * @see MutableTypescriptSymbolNumberMap
240
+ * @see MutableTypescriptSymbolBigIntMap
241
+ * @see MutableTypescriptSymbolStringMap
242
+ * @see MutableTypescriptSymbolSymbolMap
243
+ * @see MutableTypescriptSymbolJavascriptSymbolMap
244
+ * @see MutableTypescriptSymbolTypescriptSymbolMap
245
+ */
246
+ export type MutableMap<K, V, > = globalThis.Map<K, V>
package/src/empty.ts CHANGED
@@ -21,27 +21,69 @@ export type EmptyArray = readonly []
21
21
  */
22
22
  export type EmptyMutableArray = []
23
23
 
24
- /** A type-alias for an empty {@link ReadonlySet Set} */
25
- export type EmptySet = ReadonlySet<never>
24
+ /**
25
+ * A type-alias for an empty {@link ReadonlySet Set}
26
+ *
27
+ * @param T The {@link ReadonlySet Set} type (<i>{@code never} by default</i>)
28
+ * @see EmptyMutableSet
29
+ */
30
+ export type EmptySet<T = never, > = ReadonlySet<T>
31
+ /**
32
+ * A type-alias for an empty {@link Set MutableSet}
33
+ *
34
+ * @param T The {@link Set MutableSet} type (<i>{@code never} by default</i>)
35
+ * @see EmptySet
36
+ */
37
+ export type EmptyMutableSet<T = never, > = Set<T>
26
38
 
27
- /** A type-alias for an empty {@link WeakSet} */
28
- export type EmptyWeakSet = Readonly<WeakSet<WeakKey>>
39
+ /**
40
+ * A type-alias for an empty {@link WeakSet}
41
+ *
42
+ * @param T The {@link WeakSet} type (<i>{@link WeakKey} by default</i>)
43
+ * @see EmptyMutableWeakSet
44
+ */
45
+ export type EmptyWeakSet<T extends WeakKey = WeakKey, > = Readonly<WeakSet<T>>
46
+ /**
47
+ * A type-alias for an empty {@link WeakSet MutableWeakSet}
48
+ *
49
+ * @param T The {@link WeakSet MutableWeakSet} type (<i>{@link WeakKey} by default</i>)
50
+ * @see EmptyWeakSet
51
+ */
52
+ export type EmptyMutableWeakSet<T extends WeakKey = WeakKey, > = WeakSet<T>
29
53
 
30
54
  /**
31
55
  * A type-alias for an empty {@link ReadonlyMap Map}
32
56
  *
57
+ * @param K The {@link ReadonlyMap Map} key type (<i>{@code unknown} by default</i>)
58
+ * @param V The {@link ReadonlyMap Map} value type (<i>{@code never} by default</i>)
33
59
  * @see EmptyMutableMap
34
60
  */
35
- export type EmptyMap = ReadonlyMap<any, never>
61
+ export type EmptyMap<K = unknown, V = never, > = ReadonlyMap<K, V>
36
62
  /**
37
63
  * A type-alias for an empty {@link Map MutableMap}
38
64
  *
65
+ * @param K The {@link Map MutableMap} key type (<i>{@code unknown} by default</i>)
66
+ * @param V The {@link Map MutableMap} value type (<i>{@code never} by default</i>)
39
67
  * @see EmptyMap
40
68
  */
41
- export type EmptyMutableMap = Map<any, never>
69
+ export type EmptyMutableMap<K = unknown, V = never, > = Map<K, V>
42
70
 
43
- /** A type-alias for an empty {@link WeakMap} */
44
- export type EmptyWeakMap = Readonly<WeakMap<WeakKey, never>>
71
+ /**
72
+ * A type-alias for an empty {@link WeakMap}
73
+ *
74
+ * @param K The {@link WeakMap} key type (<i>{@link WeakKey} by default</i>)
75
+ * @param V The {@link WeakMap} value type (<i>{@code never} by default</i>)
76
+ * @see EmptyMutableWeakMap
77
+ */
78
+ export type EmptyWeakMap<K extends WeakKey = WeakKey, V = never, > = Readonly<WeakMap<K, V>>
79
+ /**
80
+ * A type-alias for an empty {@link WeakMap MutableWeakMap}
81
+ *
82
+ * @param K The {@link WeakMap MutableWeakMap} key type (<i>{@link WeakKey} by default</i>)
83
+ * @param V The {@link WeakMap MutableWeakMap} value type (<i>{@code never} by default</i>)
84
+ * @see EmptyWeakMap
85
+ */
86
+ export type EmptyMutableWeakMap<K extends WeakKey = WeakKey, V = never, > = WeakMap<K, V>
45
87
 
46
88
  /**
47
89
  * A type-alias for an empty {@link Object}
package/src/index.ts CHANGED
@@ -8,6 +8,13 @@
8
8
  export type * from "./boolean"
9
9
  export type * from "./boolean (false)"
10
10
  export type * from "./boolean (true)"
11
+ export type * from "./collection"
12
+ export type * from "./collection (array)"
13
+ export type * from "./collection (mutable array)"
14
+ export type * from "./collection (mutable set)"
15
+ export type * from "./collection (mutable map)"
16
+ export type * from "./collection (set)"
17
+ export type * from "./collection (map)"
11
18
  export type * from "./empty"
12
19
  export type * from "./mixed"
13
20
  export type * from "./nullable"
package/src/nullable.ts CHANGED
@@ -835,3 +835,29 @@ export type NullableJavascriptSymbol<T extends JavascriptSymbol = JavascriptSymb
835
835
  export type NullableTypescriptSymbol<T extends TypescriptSymbol = TypescriptSymbol, > = | T | undefined
836
836
 
837
837
  //#endregion -------------------- symbol --------------------
838
+ //#region -------------------- unknown --------------------
839
+
840
+ /**
841
+ * A type-alias for <b>unknown</b> or <b>undefined</b>
842
+ *
843
+ * @see UndefinedOr
844
+ * @see NullableUnknown
845
+ */
846
+ export type UndefinedOrUnknown<T extends unknown = unknown, > = | T | undefined
847
+ /**
848
+ * A type-alias for <b>unknown</b> or <b>null</b>
849
+ *
850
+ * @see NullOr
851
+ * @see NullableUnknown
852
+ */
853
+ export type NullOrUnknown<T extends unknown = unknown, > = | T | null
854
+ /**
855
+ * A type-alias for <b>unknown</b> or <b>null</b>
856
+ *
857
+ * @see Nullable
858
+ * @see UndefinedOrUnknown
859
+ * @see NullOrUnknown
860
+ */
861
+ export type NullableUnknown<T extends unknown = unknown, > = | T | null | undefined
862
+
863
+ //#endregion -------------------- unknown --------------------
@@ -9,7 +9,6 @@
9
9
  * A type-alias for <b>-1</b> (as a {@link Number} or a {@link BigInt})
10
10
  * as a primitive
11
11
  *
12
- * @see Numeric
13
12
  * @see MinusOneNumber
14
13
  * @see MinusOneBigInt
15
14
  */
@@ -33,9 +32,6 @@ export type MinusOneBigInt<T extends -1n = -1n, > = T
33
32
  * A type-alias for <b>-1</b> (as a {@link Number} or a {@link BigInt})
34
33
  * in a {@link String} template
35
34
  *
36
- * @see MinusOne
37
- * @see MinusOneNumber
38
- * @see MinusOneBigInt
39
35
  * @see Template
40
36
  * @see TemplateOrMinusOne
41
37
  * @see NumericTemplate
@@ -48,9 +44,6 @@ export type MinusOneTemplate<T extends | -1 | -1n = | -1 | -1n, > = `${T}`
48
44
  * A type-alias for <b>-1</b> (as a {@link Number} or a {@link BigInt})
49
45
  * as a primitive or in a {@link String} template
50
46
  *
51
- * @see MinusOne
52
- * @see MinusOneNumber
53
- * @see MinusOneBigInt
54
47
  * @see Template
55
48
  * @see MinusOneTemplate
56
49
  * @see TemplateOrMinusOneNumber
@@ -64,8 +57,6 @@ export type TemplateOrMinusOne<T extends | -1 | -1n = | -1 | -1n, > = | T | `${T
64
57
  * A type-alias for the {@link Number} <b>-1</b>
65
58
  * as a primitive or in a {@link String} template
66
59
  *
67
- * @see MinusOne
68
- * @see MinusOneNumber
69
60
  * @see Template
70
61
  * @see MinusOneTemplate
71
62
  * @see TemplateOrMinusOne
@@ -77,8 +68,6 @@ export type TemplateOrMinusOneNumber<T extends -1 = -1, > = | T | `${T}`
77
68
  * A type-alias for the {@link BigInt} <b>-1</b>
78
69
  * as a primitive or in a {@link String} template
79
70
  *
80
- * @see MinusOne
81
- * @see MinusOneBigInt
82
71
  * @see Template
83
72
  * @see MinusOneTemplate
84
73
  * @see TemplateOrMinusOne
@@ -9,9 +9,8 @@
9
9
  * A type-alias for <b>0</b> (as a {@link Number} or a {@link BigInt})
10
10
  * as a primitive
11
11
  *
12
- * @see Numeric
13
- * @see MinusOneNumber
14
- * @see MinusOneBigInt
12
+ * @see ZeroNumber
13
+ * @see ZeroBigInt
15
14
  */
16
15
  export type Zero<T extends | 0 | 0n = | 0 | 0n, > = T
17
16
  /**
@@ -33,9 +32,6 @@ export type ZeroBigInt<T extends 0n = 0n, > = T
33
32
  * A type-alias for <b>0</b> (as a {@link Number} or a {@link BigInt})
34
33
  * in a {@link String} template
35
34
  *
36
- * @see Zero
37
- * @see ZeroNumber
38
- * @see ZeroBigInt
39
35
  * @see Template
40
36
  * @see TemplateOrZero
41
37
  * @see TemplateOrZeroNumber
@@ -50,9 +46,6 @@ export type ZeroTemplate<T extends | 0 | 0n = | 0 | 0n, > = `${T}`
50
46
  * A type-alias for <b>0</b> (as a {@link Number} or a {@link BigInt})
51
47
  * as a primitive or in a {@link String} template
52
48
  *
53
- * @see Zero
54
- * @see ZeroNumber
55
- * @see ZeroBigInt
56
49
  * @see Template
57
50
  * @see ZeroTemplate
58
51
  * @see TemplateOrZeroNumber
@@ -66,8 +59,6 @@ export type TemplateOrZero<T extends | 0 | 0n = | 0 | 0n, > = | T | `${T}`
66
59
  * A type-alias for the {@link Number} <b>0</b>
67
60
  * as a primitive or in a {@link String} template
68
61
  *
69
- * @see Zero
70
- * @see ZeroNumber
71
62
  * @see Template
72
63
  * @see ZeroTemplate
73
64
  * @see TemplateOrZero
@@ -79,8 +70,6 @@ export type TemplateOrZeroNumber<T extends 0 = 0, > = | T | `${T}`
79
70
  * A type-alias for the {@link BigInt} <b>0</b>
80
71
  * as a primitive or in a {@link String} template
81
72
  *
82
- * @see Zero
83
- * @see ZeroBigInt
84
73
  * @see Template
85
74
  * @see ZeroTemplate
86
75
  * @see TemplateOrZero
@@ -9,9 +9,8 @@
9
9
  * A type-alias for <b>1</b> (as a {@link Number} or a {@link BigInt})
10
10
  * as a primitive
11
11
  *
12
- * @see Numeric
13
- * @see MinusOneNumber
14
- * @see MinusOneBigInt
12
+ * @see OneNumber
13
+ * @see OneBigInt
15
14
  */
16
15
  export type One<T extends | 1 | 1n = | 1 | 1n, > = T
17
16
  /**
@@ -33,9 +32,6 @@ export type OneBigInt<T extends 1n = 1n, > = T
33
32
  * A type-alias for <b>1</b> (as a {@link Number} or a {@link BigInt})
34
33
  * in a {@link String} template
35
34
  *
36
- * @see One
37
- * @see OneNumber
38
- * @see OneBigInt
39
35
  * @see Template
40
36
  * @see TemplateOrOne
41
37
  * @see TemplateOrOneNumber
@@ -50,9 +46,6 @@ export type OneTemplate<T extends | 1 | 1n = | 1 | 1n, > = `${T}`
50
46
  * A type-alias for <b>1</b> (as a {@link Number} or a {@link BigInt})
51
47
  * as a primitive or in a {@link String} template
52
48
  *
53
- * @see One
54
- * @see OneNumber
55
- * @see OneBigInt
56
49
  * @see Template
57
50
  * @see OneTemplate
58
51
  * @see TemplateOrOneNumber
@@ -66,8 +59,6 @@ export type TemplateOrOne<T extends | 1 | 1n = | 1 | 1n, > = | T | `${T}`
66
59
  * A type-alias for the {@link Number} <b>1</b>
67
60
  * as a primitive or in a {@link String} template
68
61
  *
69
- * @see One
70
- * @see OneBigInt
71
62
  * @see Template
72
63
  * @see OneTemplate
73
64
  * @see TemplateOrOne
@@ -79,8 +70,6 @@ export type TemplateOrOneNumber<T extends 1 = 1, > = | T | `${T}`
79
70
  * A type-alias for the {@link BigInt} <b>1</b>
80
71
  * as a primitive or in a {@link String} template
81
72
  *
82
- * @see One
83
- * @see OneBigInt
84
73
  * @see Template
85
74
  * @see OneTemplate
86
75
  * @see TemplateOrOne
@@ -9,9 +9,8 @@
9
9
  * A type-alias for <b>2</b> (as a {@link Number} or a {@link BigInt})
10
10
  * as a primitive
11
11
  *
12
- * @see Numeric
13
- * @see MinusTwoNumber
14
- * @see MinusTwoBigInt
12
+ * @see TwoNumber
13
+ * @see TwoBigInt
15
14
  */
16
15
  export type Two<T extends | 2 | 2n = | 2 | 2n, > = T
17
16
  /**
@@ -33,9 +32,6 @@ export type TwoBigInt<T extends 2n = 2n, > = T
33
32
  * A type-alias for <b>2</b> (as a {@link Number} or a {@link BigInt})
34
33
  * in a {@link String} template
35
34
  *
36
- * @see Two
37
- * @see TwoNumber
38
- * @see TwoBigInt
39
35
  * @see Template
40
36
  * @see TemplateOrTwo
41
37
  * @see NumberTemplate
@@ -48,9 +44,6 @@ export type TwoTemplate<T extends | 2 | 2n = | 2 | 2n, > = `${T}`
48
44
  * A type-alias for <b>2</b> (as a {@link Number} or a {@link BigInt})
49
45
  * as a primitive or in a {@link String} template
50
46
  *
51
- * @see Two
52
- * @see TwoNumber
53
- * @see TwoBigInt
54
47
  * @see Template
55
48
  * @see TwoTemplate
56
49
  * @see TemplateOrTwoNumber
@@ -64,8 +57,6 @@ export type TemplateOrTwo<T extends | 2 | 2n = | 2 | 2n, > = | T | `${T}`
64
57
  * A type-alias for the {@link Number} <b>2</b>
65
58
  * as a primitive or in a {@link String} template
66
59
  *
67
- * @see Two
68
- * @see TwoNumber
69
60
  * @see Template
70
61
  * @see TwoTemplate
71
62
  * @see TemplateOrTwo
@@ -76,8 +67,6 @@ export type TemplateOrTwoNumber<T extends 2 = 2, > = | T | `${T}`
76
67
  * A type-alias for the {@link BigInt} <b>2</b>
77
68
  * as a primitive or in a {@link String} template
78
69
  *
79
- * @see Two
80
- * @see TwoBigInt
81
70
  * @see Template
82
71
  * @see TwoTemplate
83
72
  * @see TemplateOrTwo