@oscarpalmer/atoms 0.176.0 → 0.177.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.
- package/dist/array/exists.mjs +1 -1
- package/dist/array/filter.d.mts +26 -0
- package/dist/array/find.d.mts +1 -1
- package/dist/array/find.mjs +2 -2
- package/dist/array/first.d.mts +71 -0
- package/dist/array/first.mjs +11 -0
- package/dist/array/index.d.mts +2 -1
- package/dist/array/index.mjs +2 -1
- package/dist/array/last.d.mts +71 -0
- package/dist/array/last.mjs +11 -0
- package/dist/array/select.d.mts +42 -0
- package/dist/array/single.d.mts +34 -0
- package/dist/array/single.mjs +10 -0
- package/dist/index.d.mts +281 -8
- package/dist/index.mjs +120 -22
- package/dist/internal/array/find.d.mts +11 -4
- package/dist/internal/array/find.mjs +19 -11
- package/dist/internal/is.d.mts +9 -1
- package/dist/internal/is.mjs +30 -6
- package/dist/is.d.mts +38 -8
- package/dist/is.mjs +47 -7
- package/package.json +10 -2
- package/plugin/index.js +2 -1
- package/src/array/exists.ts +1 -1
- package/src/array/filter.ts +26 -0
- package/src/array/find.ts +4 -4
- package/src/array/first.ts +113 -0
- package/src/array/index.ts +1 -0
- package/src/array/last.ts +109 -0
- package/src/array/select.ts +84 -0
- package/src/array/single.ts +64 -0
- package/src/index.ts +2 -0
- package/src/internal/array/find.ts +36 -10
- package/src/internal/is.ts +93 -11
- package/src/is.ts +63 -6
package/dist/index.d.mts
CHANGED
|
@@ -178,11 +178,105 @@ declare function filter<Item>(array: Item[], item: Item): Item[];
|
|
|
178
178
|
declare namespace filter {
|
|
179
179
|
var remove: typeof removeFiltered;
|
|
180
180
|
}
|
|
181
|
+
/**
|
|
182
|
+
* Get a filtered array of items that do not match the filter
|
|
183
|
+
* @param array Array to search in
|
|
184
|
+
* @param callback Callback to get an item's value for matching
|
|
185
|
+
* @param value Value to match against
|
|
186
|
+
* @returns Filtered array of items that do not match the filter
|
|
187
|
+
*/
|
|
181
188
|
declare function removeFiltered<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], callback: Callback, value: ReturnType<Callback>): unknown[];
|
|
189
|
+
/**
|
|
190
|
+
* Get a filtered array of items that do not match the filter
|
|
191
|
+
* @param array Array to search in
|
|
192
|
+
* @param key Key to get an item's value for matching
|
|
193
|
+
* @param value Value to match against
|
|
194
|
+
* @returns Filtered array of items that do not match the filter
|
|
195
|
+
*/
|
|
182
196
|
declare function removeFiltered<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): unknown[];
|
|
197
|
+
/**
|
|
198
|
+
* Get a filtered array of items that do not match the filter
|
|
199
|
+
* @param array Array to search in
|
|
200
|
+
* @param filter Filter callback to match items
|
|
201
|
+
* @returns Filtered array of items that do not match the filter
|
|
202
|
+
*/
|
|
183
203
|
declare function removeFiltered<Item>(array: Item[], filter: (item: Item, index: number, array: Item[]) => boolean): unknown[];
|
|
204
|
+
/**
|
|
205
|
+
* Get a filtered array of items that do not match the given item
|
|
206
|
+
* @param array Array to search in
|
|
207
|
+
* @param item Item to match against
|
|
208
|
+
* @returns Filtered array of items that do not match the given item
|
|
209
|
+
*/
|
|
184
210
|
declare function removeFiltered<Item>(array: Item[], item: Item): unknown[];
|
|
185
211
|
//#endregion
|
|
212
|
+
//#region src/array/first.d.ts
|
|
213
|
+
/**
|
|
214
|
+
* Get the first item matching the given value
|
|
215
|
+
* @param array Array to search in
|
|
216
|
+
* @param callback Callback to get an item's value for matching
|
|
217
|
+
* @param value Value to match against
|
|
218
|
+
* @returns First item that matches the value, or `undefined` if no match is found
|
|
219
|
+
*/
|
|
220
|
+
declare function first<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], callback: Callback, value: ReturnType<Callback>): Item | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* Get the first item matching the given value by key
|
|
223
|
+
* @param array Array to search in
|
|
224
|
+
* @param key Key to get an item's value for matching
|
|
225
|
+
* @param value Value to match against
|
|
226
|
+
* @returns First item that matches the value, or `undefined` if no match is found
|
|
227
|
+
*/
|
|
228
|
+
declare function first<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* Get the first item matching the filter
|
|
231
|
+
* @param array Array to search in
|
|
232
|
+
* @param filter Filter callback to match items
|
|
233
|
+
* @returns First item that matches the filter, or `undefined` if no match is found
|
|
234
|
+
*/
|
|
235
|
+
declare function first<Item>(array: Item[], filter: (item: Item, index: number, array: Item[]) => boolean): Item | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* Get the first item from an array
|
|
238
|
+
* @param array Array to get from
|
|
239
|
+
* @return First item from the array, or `undefined` if the array is empty
|
|
240
|
+
*/
|
|
241
|
+
declare function first<Item>(array: Item[]): Item | undefined;
|
|
242
|
+
declare namespace first {
|
|
243
|
+
var _a: typeof firstOrDefault;
|
|
244
|
+
export { _a as default };
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Get the first item matching the given value
|
|
248
|
+
* @param array Array to search in
|
|
249
|
+
* @param defaultValue Default value to return if no match is found
|
|
250
|
+
* @param callback Callback to get an item's value for matching
|
|
251
|
+
* @param value Value to match against
|
|
252
|
+
* @returns First item that matches the value, or the default value if no match is found
|
|
253
|
+
*/
|
|
254
|
+
declare function firstOrDefault<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], defaultValue: Item, callback: Callback, value: ReturnType<Callback>): Item;
|
|
255
|
+
/**
|
|
256
|
+
* Get the first item matching the given value by key
|
|
257
|
+
* @param array Array to search in
|
|
258
|
+
* @param defaultValue Default value to return if no match is found
|
|
259
|
+
* @param key Key to get an item's value for matching
|
|
260
|
+
* @param value Value to match against
|
|
261
|
+
* @returns First item that matches the value, or the default value if no match is found
|
|
262
|
+
*/
|
|
263
|
+
declare function firstOrDefault<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], defaultValue: Item, key: ItemKey, value: Item[ItemKey]): Item;
|
|
264
|
+
/**
|
|
265
|
+
* Get the first item matching the filter
|
|
266
|
+
* @param array Array to search in
|
|
267
|
+
* @param defaultValue Default value to return if no match is found
|
|
268
|
+
* @param filter Filter callback to match items
|
|
269
|
+
* @returns First item that matches the filter, or the default value if no match is found
|
|
270
|
+
*/
|
|
271
|
+
declare function firstOrDefault<Item>(array: Item[], defaultValue: Item, filter: (item: Item, index: number, array: Item[]) => boolean): Item;
|
|
272
|
+
/**
|
|
273
|
+
* Get the first item from an array
|
|
274
|
+
* @param array Array to get from
|
|
275
|
+
* @param defaultValue Default value to return if the array is empty
|
|
276
|
+
* @return First item from the array, or the default value if the array is empty
|
|
277
|
+
*/
|
|
278
|
+
declare function firstOrDefault<Item>(array: Item[], defaultValue: Item): Item;
|
|
279
|
+
//#endregion
|
|
186
280
|
//#region src/array/group-by.d.ts
|
|
187
281
|
/**
|
|
188
282
|
* Create a record from an array of items using a specific key and value
|
|
@@ -421,7 +515,7 @@ declare function exists<Item>(array: Item[], item: Item): boolean;
|
|
|
421
515
|
//#endregion
|
|
422
516
|
//#region src/array/find.d.ts
|
|
423
517
|
/**
|
|
424
|
-
* Get the first
|
|
518
|
+
* Get the first item matching the given value
|
|
425
519
|
* @param array Array to search in
|
|
426
520
|
* @param callback Callback to get an item's value for matching
|
|
427
521
|
* @param value Value to match against
|
|
@@ -745,6 +839,15 @@ declare function push<Item>(array: Item[], pushed: Item[]): number;
|
|
|
745
839
|
* @returns Filtered and mapped array of items
|
|
746
840
|
*/
|
|
747
841
|
declare function select<Item, FilterCallback extends (item: Item, index: number, array: Item[]) => unknown, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filterCallback: FilterCallback, filterValue: ReturnType<FilterCallback>, mapCallback: MapCallback): Array<ReturnType<MapCallback>>;
|
|
842
|
+
/**
|
|
843
|
+
* Get a filtered and mapped array of items
|
|
844
|
+
* @param array Array to search in
|
|
845
|
+
* @param filterCallback Callback to get an item's value for matching
|
|
846
|
+
* @param filterValue Value to match against
|
|
847
|
+
* @param mapKey Key to get an item's value for mapping
|
|
848
|
+
* @returns Filtered and mapped array of items
|
|
849
|
+
*/
|
|
850
|
+
declare function select<Item extends PlainObject, FilterCallback extends (item: Item, index: number, array: Item[]) => unknown, MapKey extends keyof Item>(array: Item[], filterCallback: FilterCallback, filterValue: ReturnType<FilterCallback>, mapKey: MapKey): Array<Item[MapKey]>;
|
|
748
851
|
/**
|
|
749
852
|
* Get a filtered and mapped array of items
|
|
750
853
|
* @param array Array to search in
|
|
@@ -754,6 +857,15 @@ declare function select<Item, FilterCallback extends (item: Item, index: number,
|
|
|
754
857
|
* @returns Filtered and mapped array of items
|
|
755
858
|
*/
|
|
756
859
|
declare function select<Item extends PlainObject, ItemKey extends keyof Item, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filterKey: ItemKey, filterValue: Item[ItemKey], mapCallback: MapCallback): Array<ReturnType<MapCallback>>;
|
|
860
|
+
/**
|
|
861
|
+
* Get a filtered and mapped array of items
|
|
862
|
+
* @param array Array to search in
|
|
863
|
+
* @param filterKey Key to get an item's value for matching
|
|
864
|
+
* @param filterValue Value to match against
|
|
865
|
+
* @param mapKey Key to get an item's value for mapping
|
|
866
|
+
* @returns Filtered and mapped array of items
|
|
867
|
+
*/
|
|
868
|
+
declare function select<Item extends PlainObject, ItemKey extends keyof Item, MapKey extends keyof Item>(array: Item[], filterKey: ItemKey, filterValue: Item[ItemKey], mapKey: MapKey): Array<Item[MapKey]>;
|
|
757
869
|
/**
|
|
758
870
|
* Get a filtered and mapped array of items
|
|
759
871
|
* @param array Array to search in
|
|
@@ -762,6 +874,14 @@ declare function select<Item extends PlainObject, ItemKey extends keyof Item, Ma
|
|
|
762
874
|
* @returns Filtered and mapped array of items
|
|
763
875
|
*/
|
|
764
876
|
declare function select<Item, FilterCallback extends (item: Item, index: number, array: Item[]) => unknown, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filterCallback: FilterCallback, filterValue: ReturnType<FilterCallback>, mapCallback: MapCallback): Array<ReturnType<MapCallback>>;
|
|
877
|
+
/**
|
|
878
|
+
* Get a filtered and mapped array of items
|
|
879
|
+
* @param array Array to search in
|
|
880
|
+
* @param filterCallback Filter callback to match items
|
|
881
|
+
* @param mapKey Key to get an item's value for mapping
|
|
882
|
+
* @returns Filtered and mapped array of items
|
|
883
|
+
*/
|
|
884
|
+
declare function select<Item extends PlainObject, FilterCallback extends (item: Item, index: number, array: Item[]) => unknown, MapKey extends keyof Item>(array: Item[], filterCallback: FilterCallback, filterValue: ReturnType<FilterCallback>, mapKey: MapKey): Array<Item[MapKey]>;
|
|
765
885
|
/**
|
|
766
886
|
* Get a filtered and mapped array of items
|
|
767
887
|
* @param array Array to search in
|
|
@@ -770,6 +890,14 @@ declare function select<Item, FilterCallback extends (item: Item, index: number,
|
|
|
770
890
|
* @returns Filtered and mapped array of items
|
|
771
891
|
*/
|
|
772
892
|
declare function select<Item, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filter: (item: Item, index: number, array: Item[]) => boolean, map: MapCallback): Array<ReturnType<MapCallback>>;
|
|
893
|
+
/**
|
|
894
|
+
* Get a filtered and mapped array of items
|
|
895
|
+
* @param array Array to search in
|
|
896
|
+
* @param filter Filter callback to match items
|
|
897
|
+
* @param map Key to get an item's value for mapping
|
|
898
|
+
* @returns Filtered and mapped array of items
|
|
899
|
+
*/
|
|
900
|
+
declare function select<Item extends PlainObject, MapKey extends keyof Item>(array: Item[], filter: (item: Item, index: number, array: Item[]) => boolean, map: MapKey): Array<Item[MapKey]>;
|
|
773
901
|
/**
|
|
774
902
|
* Get a filtered and mapped array of items
|
|
775
903
|
* @param array Array to search in
|
|
@@ -778,6 +906,45 @@ declare function select<Item, MapCallback extends (item: Item, index: number, ar
|
|
|
778
906
|
* @returns Filtered and mapped array of items
|
|
779
907
|
*/
|
|
780
908
|
declare function select<Item, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filter: Item, map: MapCallback): Array<ReturnType<MapCallback>>;
|
|
909
|
+
/**
|
|
910
|
+
* Get a filtered and mapped array of items
|
|
911
|
+
* @param array Array to search in
|
|
912
|
+
* @param item Item to match against
|
|
913
|
+
* @param map Key to get an item's value for mapping
|
|
914
|
+
* @returns Filtered and mapped array of items
|
|
915
|
+
*/
|
|
916
|
+
declare function select<Item extends PlainObject, MapKey extends keyof Item>(array: Item[], filter: Item, map: MapKey): Array<Item[MapKey]>;
|
|
917
|
+
//#endregion
|
|
918
|
+
//#region src/array/single.d.ts
|
|
919
|
+
/**
|
|
920
|
+
* Get the _only_ item matching the given value
|
|
921
|
+
*
|
|
922
|
+
* Throws an error if multiple items match the value
|
|
923
|
+
* @param array Array to search in
|
|
924
|
+
* @param callback Callback to get an item's value for matching
|
|
925
|
+
* @param value Value to match against
|
|
926
|
+
* @returns Only item that matches the value, or `undefined` if no match is found
|
|
927
|
+
*/
|
|
928
|
+
declare function single<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], callback: Callback, value: ReturnType<Callback>): Item | undefined;
|
|
929
|
+
/**
|
|
930
|
+
* Get the _only_ item matching the given value by key
|
|
931
|
+
*
|
|
932
|
+
* Throws an error if multiple items match the value
|
|
933
|
+
* @param array Array to search in
|
|
934
|
+
* @param key Key to get an item's value for matching
|
|
935
|
+
* @param value Value to match against
|
|
936
|
+
* @returns Only item that matches the value, or `undefined` if no match is found
|
|
937
|
+
*/
|
|
938
|
+
declare function single<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item | undefined;
|
|
939
|
+
/**
|
|
940
|
+
* Get the _only_ item matching the filter
|
|
941
|
+
*
|
|
942
|
+
* Throws an error if multiple items match the filter
|
|
943
|
+
* @param array Array to search in
|
|
944
|
+
* @param filter Filter callback to match items
|
|
945
|
+
* @returns Only item that matches the filter, or `undefined` if no match is found
|
|
946
|
+
*/
|
|
947
|
+
declare function single<Item>(array: Item[], filter: (item: Item, index: number, array: Item[]) => boolean): Item | undefined;
|
|
781
948
|
//#endregion
|
|
782
949
|
//#region src/array/slice.d.ts
|
|
783
950
|
/**
|
|
@@ -1015,6 +1182,74 @@ declare function update<Item extends PlainObject, ItemKey extends keyof Item>(de
|
|
|
1015
1182
|
*/
|
|
1016
1183
|
declare function update<Item>(destination: Item[], updated: Item[]): Item[];
|
|
1017
1184
|
//#endregion
|
|
1185
|
+
//#region src/array/last.d.ts
|
|
1186
|
+
/**
|
|
1187
|
+
* Get the last items matching the given value
|
|
1188
|
+
* @param array Array to search in
|
|
1189
|
+
* @param callback Callback to get an item's value for matching
|
|
1190
|
+
* @param value Value to match against
|
|
1191
|
+
* @returns Last item that matches the value, or `undefined` if no match is found
|
|
1192
|
+
*/
|
|
1193
|
+
declare function last<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], callback: Callback, value: ReturnType<Callback>): Item | undefined;
|
|
1194
|
+
/**
|
|
1195
|
+
* Get the first item matching the given value by key
|
|
1196
|
+
* @param array Array to search in
|
|
1197
|
+
* @param key Key to get an item's value for matching
|
|
1198
|
+
* @param value Value to match against
|
|
1199
|
+
* @returns Last item that matches the value, or `undefined` if no match is found
|
|
1200
|
+
*/
|
|
1201
|
+
declare function last<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item | undefined;
|
|
1202
|
+
/**
|
|
1203
|
+
* Get the last item matching the filter
|
|
1204
|
+
* @param array Array to search in
|
|
1205
|
+
* @param filter Filter callback to match items
|
|
1206
|
+
* @returns Last item that matches the filter, or `undefined` if no match is found
|
|
1207
|
+
*/
|
|
1208
|
+
declare function last<Item>(array: Item[], filter: (item: Item, index: number, array: Item[]) => boolean): Item | undefined;
|
|
1209
|
+
/**
|
|
1210
|
+
* Get the last item from an array
|
|
1211
|
+
* @param array Array to get from
|
|
1212
|
+
* @return Last item from the array, or `undefined` if the array is empty
|
|
1213
|
+
*/
|
|
1214
|
+
declare function last<Item>(array: Item[]): Item | undefined;
|
|
1215
|
+
declare namespace last {
|
|
1216
|
+
var _a: typeof lastOrDefault;
|
|
1217
|
+
export { _a as default };
|
|
1218
|
+
}
|
|
1219
|
+
/**
|
|
1220
|
+
* Get the last item matching the given value
|
|
1221
|
+
* @param array Array to search in
|
|
1222
|
+
* @param defaultValue Default value to return if no match is found
|
|
1223
|
+
* @param callback Callback to get an item's value for matching
|
|
1224
|
+
* @param value Value to match against
|
|
1225
|
+
* @returns Last item that matches the value, or the default value if no match is found
|
|
1226
|
+
*/
|
|
1227
|
+
declare function lastOrDefault<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], defaultValue: Item, callback: Callback, value: ReturnType<Callback>): Item;
|
|
1228
|
+
/**
|
|
1229
|
+
* Get the last item matching the given value by key
|
|
1230
|
+
* @param array Array to search in
|
|
1231
|
+
* @param defaultValue Default value to return if no match is found
|
|
1232
|
+
* @param key Key to get an item's value for matching
|
|
1233
|
+
* @param value Value to match against
|
|
1234
|
+
* @returns Last item that matches the value, or the default value if no match is found
|
|
1235
|
+
*/
|
|
1236
|
+
declare function lastOrDefault<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], defaultValue: Item, key: ItemKey, value: Item[ItemKey]): Item;
|
|
1237
|
+
/**
|
|
1238
|
+
* Get the last item matching the filter
|
|
1239
|
+
* @param array Array to search in
|
|
1240
|
+
* @param defaultValue Default value to return if no match is found
|
|
1241
|
+
* @param filter Filter callback to match items
|
|
1242
|
+
* @returns Last item that matches the filter, or the default value if no match is found
|
|
1243
|
+
*/
|
|
1244
|
+
declare function lastOrDefault<Item>(array: Item[], defaultValue: Item, filter: (item: Item, index: number, array: Item[]) => boolean): Item;
|
|
1245
|
+
/**
|
|
1246
|
+
* Get the last item from an array
|
|
1247
|
+
* @param array Array to get from
|
|
1248
|
+
* @param defaultValue Default value to return if the array is empty
|
|
1249
|
+
* @return Last item from the array, or the default value if the array is empty
|
|
1250
|
+
*/
|
|
1251
|
+
declare function lastOrDefault<Item>(array: Item[], defaultValue: Item): Item;
|
|
1252
|
+
//#endregion
|
|
1018
1253
|
//#region src/array/move.d.ts
|
|
1019
1254
|
/**
|
|
1020
1255
|
* Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
|
|
@@ -3108,6 +3343,14 @@ declare function isInstanceOf<Instance>(constructor: Constructor<Instance>, valu
|
|
|
3108
3343
|
* @returns `true` if the value is a `Key` _(`number` or `string`)_, otherwise `false`
|
|
3109
3344
|
*/
|
|
3110
3345
|
declare function isKey(value: unknown): value is Key;
|
|
3346
|
+
declare function isNonArrayOrPlainObject<Value>(value: Value): value is Exclude<Value, ArrayOrPlainObject>;
|
|
3347
|
+
declare function isNonConstructor<Value>(value: Value): value is Exclude<Value, Constructor>;
|
|
3348
|
+
declare function isNonInstanceOf<Instance, Value>(constructor: Constructor<Instance>, value: Value): value is Exclude<Value, Instance>;
|
|
3349
|
+
declare function isNonKey<Value>(value: Value): value is Exclude<Value, Key>;
|
|
3350
|
+
declare function isNonNumber<Value>(value: Value): value is Exclude<Value, number>;
|
|
3351
|
+
declare function isNonPlainObject<Value>(value: Value): value is Exclude<Value, PlainObject>;
|
|
3352
|
+
declare function isNonPrimitive<Value>(value: Value): value is Exclude<Value, Primitive>;
|
|
3353
|
+
declare function isNonTypedArray<Value>(value: Value): value is Exclude<Value, TypedArray>;
|
|
3111
3354
|
/**
|
|
3112
3355
|
* Is the value a number?
|
|
3113
3356
|
* @param value Value to check
|
|
@@ -3140,12 +3383,42 @@ declare function isTypedArray(value: unknown): value is TypedArray;
|
|
|
3140
3383
|
* @returns `true` if the value is considered empty, otherwise `false`
|
|
3141
3384
|
*/
|
|
3142
3385
|
declare function isEmpty(value: unknown): boolean;
|
|
3386
|
+
/**
|
|
3387
|
+
* Is the value not empty, or holding non-empty values?
|
|
3388
|
+
* @param value Value to check
|
|
3389
|
+
* @returns `true` if the value is not considered empty, otherwise `false`
|
|
3390
|
+
*/
|
|
3391
|
+
declare function isNonEmpty(value: unknown): boolean;
|
|
3143
3392
|
/**
|
|
3144
3393
|
* Is the value not `undefined` or `null`?
|
|
3145
3394
|
* @param value Value to check
|
|
3146
3395
|
* @returns `true` if the value is not `undefined` or `null`, otherwise `false`
|
|
3147
3396
|
*/
|
|
3148
|
-
declare function isNonNullable(value:
|
|
3397
|
+
declare function isNonNullable<Value>(value: Value): value is Exclude<Value, undefined | null>;
|
|
3398
|
+
/**
|
|
3399
|
+
* Is the value not `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
|
|
3400
|
+
* @param value Value to check
|
|
3401
|
+
* @returns `true` if the value is not `undefined`, `null`, or matches an empty string, otherwise `false`
|
|
3402
|
+
*/
|
|
3403
|
+
declare function isNonNullableOrEmpty<Value>(value: Value): value is Exclude<Value, undefined | null | ''>;
|
|
3404
|
+
/**
|
|
3405
|
+
* Is the value not `undefined`, `null`, or stringified as a whitespace-only string?
|
|
3406
|
+
* @param value Value to check
|
|
3407
|
+
* @returns `true` if the value is not `undefined`, `null`, or matches a whitespace-only string, otherwise `false`
|
|
3408
|
+
*/
|
|
3409
|
+
declare function isNonNullableOrWhitespace<Value>(value: Value): value is Exclude<Value, undefined | null | ''>;
|
|
3410
|
+
/**
|
|
3411
|
+
* Is the value not a number or a number-like string?
|
|
3412
|
+
* @param value Value to check
|
|
3413
|
+
* @returns `true` if the value is not a number or a number-like string, otherwise `false`
|
|
3414
|
+
*/
|
|
3415
|
+
declare function isNonNumerical<Value>(value: Value): value is Exclude<Value, number | `${number}`>;
|
|
3416
|
+
/**
|
|
3417
|
+
* Is the value not an object _(or function)_?
|
|
3418
|
+
* @param value Value to check
|
|
3419
|
+
* @returns `true` if the value is not an object, otherwise `false`
|
|
3420
|
+
*/
|
|
3421
|
+
declare function isNonObject<Value>(value: Value): value is Exclude<Value, object>;
|
|
3149
3422
|
/**
|
|
3150
3423
|
* Is the value `undefined` or `null`?
|
|
3151
3424
|
* @param value Value to check
|
|
@@ -3153,21 +3426,21 @@ declare function isNonNullable(value: unknown): value is Exclude<unknown, undefi
|
|
|
3153
3426
|
*/
|
|
3154
3427
|
declare function isNullable(value: unknown): value is undefined | null;
|
|
3155
3428
|
/**
|
|
3156
|
-
* Is the value `undefined`, `null`, or an empty _(no whitespace)_ string?
|
|
3429
|
+
* Is the value `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
|
|
3157
3430
|
* @param value Value to check
|
|
3158
|
-
* @returns `true` if the value is nullable or an empty string, otherwise `false`
|
|
3431
|
+
* @returns `true` if the value is nullable or matches an empty string, otherwise `false`
|
|
3159
3432
|
*/
|
|
3160
3433
|
declare function isNullableOrEmpty(value: unknown): value is undefined | null | '';
|
|
3161
3434
|
/**
|
|
3162
|
-
* Is the value `undefined`, `null`, or a whitespace-only string?
|
|
3435
|
+
* Is the value `undefined`, `null`, or stringified as a whitespace-only string?
|
|
3163
3436
|
* @param value Value to check
|
|
3164
|
-
* @returns `true` if the value is nullable or a whitespace-only string, otherwise `false`
|
|
3437
|
+
* @returns `true` if the value is nullable or matches a whitespace-only string, otherwise `false`
|
|
3165
3438
|
*/
|
|
3166
3439
|
declare function isNullableOrWhitespace(value: unknown): value is undefined | null | '';
|
|
3167
3440
|
/**
|
|
3168
3441
|
* Is the value a number or a number-like string?
|
|
3169
3442
|
* @param value Value to check
|
|
3170
|
-
* @returns `true` if the value is a number or a
|
|
3443
|
+
* @returns `true` if the value is a number or a number-like string, otherwise `false`
|
|
3171
3444
|
*/
|
|
3172
3445
|
declare function isNumerical(value: unknown): value is number | `${number}`;
|
|
3173
3446
|
/**
|
|
@@ -4507,4 +4780,4 @@ declare class SizedSet<Value = unknown> extends Set<Value> {
|
|
|
4507
4780
|
get(value: Value, update?: boolean): Value | undefined;
|
|
4508
4781
|
}
|
|
4509
4782
|
//#endregion
|
|
4510
|
-
export { AnyResult, ArrayComparisonSorter, ArrayKeySorter, ArrayOrPlainObject, ArrayPosition, ArrayValueSorter, Asserter, AsyncCancelableCallback, AttemptFlow, AttemptFlowPromise, type Beacon, type BeaconOptions, BuiltIns, CancelableCallback, CancelablePromise, type Color, Constructor, DiffOptions, DiffResult, DiffValue, EqualOptions, Err, EventPosition, ExtendedErr, ExtendedResult, Flow, FlowPromise, FulfilledPromise, GenericAsyncCallback, GenericCallback, type HSLAColor, type HSLColor, HasValue, Key, KeyedValue, type Logger, type Memoized, type MemoizedOptions, MergeOptions, Merger, NestedArray, NestedKeys, NestedPartial, NestedValue, NestedValues, NumericalKeys, NumericalValues, type Observable, type Observer, Ok, OnceAsyncCallback, OnceCallback, PROMISE_ABORT_EVENT, PROMISE_ABORT_OPTIONS, PROMISE_ERROR_NAME, PROMISE_MESSAGE_EXPECTATION_ATTEMPT, PROMISE_MESSAGE_EXPECTATION_RESULT, PROMISE_MESSAGE_EXPECTATION_TIMED, PROMISE_MESSAGE_TIMEOUT, PROMISE_STRATEGY_ALL, PROMISE_STRATEGY_DEFAULT, PROMISE_TYPE_FULFILLED, PROMISE_TYPE_REJECTED, PlainObject, Primitive, PromiseData, PromiseHandlers, PromiseOptions, PromiseParameters, PromiseStrategy, PromiseTimeoutError, PromisesItems, PromisesOptions, PromisesResult, PromisesUnwrapped, PromisesValue, PromisesValues, type Queue, QueueError, type QueueOptions, type Queued, type QueuedResult, type RGBAColor, type RGBColor, RejectedPromise, RequiredKeys, Result, ResultMatch, RetryError, RetryOptions, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING, Simplify, SizedMap, SizedSet, Smushed, SortDirection, Sorter, type Subscription, TemplateOptions, type Time, ToString, TypedArray, Unsmushed, UnwrapValue, assert, attempt, attemptFlow, attemptPipe, attemptPromise, average, beacon, between, camelCase, cancelable, capitalize, ceil, chunk, clamp, clone, compact, compare, count, debounce, delay, diff, difference, drop, endsWith, endsWithArray, equal, error, exists, filter, find, flatten, floor, flow, fromQuery, toPromise as fromResult, toPromise, getArray, getArrayPosition, getColor, getError, getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getNormalizedHex, getNumber, getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems, getRgbColor, getRgbaColor, getString, getTimedPromise, getUuid, getValue, groupBy, handleResult, hasValue, hexToHsl, hexToHsla, hexToRgb, hexToRgba, hslToHex, hslToRgb, hslToRgba, ignoreKey, inMap, inSet, includes, includesArray, indexOf, indexOfArray, insert, intersection, isArrayOrPlainObject, isColor, isConstructor, isEmpty, isError, isFulfilled, isHexColor, isHslColor, isHslLike, isHslaColor, isInstanceOf, isKey, isNonNullable, isNullable, isNullableOrEmpty, isNullableOrWhitespace, isNumber, isNumerical, isObject, isOk, isPlainObject, isPrimitive, isRejected, isResult, isRgbColor, isRgbLike, isRgbaColor, isTypedArray, join, kebabCase, logger, lowerCase, matchResult, max, median, memoize, merge, min, move, noop, ok, omit, once, parse, partition, pascalCase, pick, pipe, promises, push, queue, range, retry, rgbToHex, rgbToHsl, rgbToHsla, round, select, setValue, settlePromise, shuffle, slice, smush, snakeCase, sort, splice, startsWith, startsWithArray, sum, swap, take, template, throttle, timed, times, titleCase, toMap, toQuery, toRecord, toResult, toSet, toggle, trim, truncate, tryDecode, tryEncode, union, unique, unsmush, unwrap, update, upperCase, words };
|
|
4783
|
+
export { AnyResult, ArrayComparisonSorter, ArrayKeySorter, ArrayOrPlainObject, ArrayPosition, ArrayValueSorter, Asserter, AsyncCancelableCallback, AttemptFlow, AttemptFlowPromise, type Beacon, type BeaconOptions, BuiltIns, CancelableCallback, CancelablePromise, type Color, Constructor, DiffOptions, DiffResult, DiffValue, EqualOptions, Err, EventPosition, ExtendedErr, ExtendedResult, Flow, FlowPromise, FulfilledPromise, GenericAsyncCallback, GenericCallback, type HSLAColor, type HSLColor, HasValue, Key, KeyedValue, type Logger, type Memoized, type MemoizedOptions, MergeOptions, Merger, NestedArray, NestedKeys, NestedPartial, NestedValue, NestedValues, NumericalKeys, NumericalValues, type Observable, type Observer, Ok, OnceAsyncCallback, OnceCallback, PROMISE_ABORT_EVENT, PROMISE_ABORT_OPTIONS, PROMISE_ERROR_NAME, PROMISE_MESSAGE_EXPECTATION_ATTEMPT, PROMISE_MESSAGE_EXPECTATION_RESULT, PROMISE_MESSAGE_EXPECTATION_TIMED, PROMISE_MESSAGE_TIMEOUT, PROMISE_STRATEGY_ALL, PROMISE_STRATEGY_DEFAULT, PROMISE_TYPE_FULFILLED, PROMISE_TYPE_REJECTED, PlainObject, Primitive, PromiseData, PromiseHandlers, PromiseOptions, PromiseParameters, PromiseStrategy, PromiseTimeoutError, PromisesItems, PromisesOptions, PromisesResult, PromisesUnwrapped, PromisesValue, PromisesValues, type Queue, QueueError, type QueueOptions, type Queued, type QueuedResult, type RGBAColor, type RGBColor, RejectedPromise, RequiredKeys, Result, ResultMatch, RetryError, RetryOptions, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING, Simplify, SizedMap, SizedSet, Smushed, SortDirection, Sorter, type Subscription, TemplateOptions, type Time, ToString, TypedArray, Unsmushed, UnwrapValue, assert, attempt, attemptFlow, attemptPipe, attemptPromise, average, beacon, between, camelCase, cancelable, capitalize, ceil, chunk, clamp, clone, compact, compare, count, debounce, delay, diff, difference, drop, endsWith, endsWithArray, equal, error, exists, filter, find, first, flatten, floor, flow, fromQuery, toPromise as fromResult, toPromise, getArray, getArrayPosition, getColor, getError, getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getNormalizedHex, getNumber, getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems, getRgbColor, getRgbaColor, getString, getTimedPromise, getUuid, getValue, groupBy, handleResult, hasValue, hexToHsl, hexToHsla, hexToRgb, hexToRgba, hslToHex, hslToRgb, hslToRgba, ignoreKey, inMap, inSet, includes, includesArray, indexOf, indexOfArray, insert, intersection, isArrayOrPlainObject, isColor, isConstructor, isEmpty, isError, isFulfilled, isHexColor, isHslColor, isHslLike, isHslaColor, isInstanceOf, isKey, isNonArrayOrPlainObject, isNonConstructor, isNonEmpty, isNonInstanceOf, isNonKey, isNonNullable, isNonNullableOrEmpty, isNonNullableOrWhitespace, isNonNumber, isNonNumerical, isNonObject, isNonPlainObject, isNonPrimitive, isNonTypedArray, isNullable, isNullableOrEmpty, isNullableOrWhitespace, isNumber, isNumerical, isObject, isOk, isPlainObject, isPrimitive, isRejected, isResult, isRgbColor, isRgbLike, isRgbaColor, isTypedArray, join, kebabCase, last, logger, lowerCase, matchResult, max, median, memoize, merge, min, move, noop, ok, omit, once, parse, partition, pascalCase, pick, pipe, promises, push, queue, range, retry, rgbToHex, rgbToHsl, rgbToHsla, round, select, setValue, settlePromise, shuffle, single, slice, smush, snakeCase, sort, splice, startsWith, startsWithArray, sum, swap, take, template, throttle, timed, times, titleCase, toMap, toQuery, toRecord, toResult, toSet, toggle, trim, truncate, tryDecode, tryEncode, union, unique, unsmush, unwrap, update, upperCase, words };
|