@ls-stack/utils 3.35.0 → 3.36.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/arrayUtils.cjs +11 -1
- package/dist/arrayUtils.d.cts +20 -1
- package/dist/arrayUtils.d.ts +20 -1
- package/dist/arrayUtils.js +3 -1
- package/dist/{chunk-4DVTWCXL.js → chunk-27AL66CH.js} +10 -1
- package/dist/{chunk-XPOGWCUC.js → chunk-6CG6JZKB.js} +1 -1
- package/dist/concurrentCalls.js +1 -1
- package/dist/filterObjectOrArrayKeys.js +2 -2
- package/dist/serializeXML.js +1 -1
- package/dist/testUtils.js +2 -2
- package/docs/arrayUtils/-internal-.md +24 -0
- package/docs/arrayUtils/README.md +57 -1
- package/package.json +1 -1
package/dist/arrayUtils.cjs
CHANGED
|
@@ -25,6 +25,7 @@ __export(arrayUtils_exports, {
|
|
|
25
25
|
arrayWithPrevAndIndex: () => arrayWithPrevAndIndex,
|
|
26
26
|
filterAndMap: () => filterAndMap,
|
|
27
27
|
findAfterIndex: () => findAfterIndex,
|
|
28
|
+
findAndMap: () => findAndMap,
|
|
28
29
|
findBeforeIndex: () => findBeforeIndex,
|
|
29
30
|
getAscIndexOrder: () => getAscIndexOrder,
|
|
30
31
|
hasDuplicates: () => hasDuplicates,
|
|
@@ -160,11 +161,19 @@ function truncateArray(array, maxLength, appendIfTruncated) {
|
|
|
160
161
|
}
|
|
161
162
|
return result;
|
|
162
163
|
}
|
|
164
|
+
function findAndMap(array, predicate) {
|
|
165
|
+
for (const item of array) {
|
|
166
|
+
const value = predicate(item);
|
|
167
|
+
if (value !== false) return value;
|
|
168
|
+
}
|
|
169
|
+
return void 0;
|
|
170
|
+
}
|
|
163
171
|
function arrayOps(array) {
|
|
164
172
|
return {
|
|
165
173
|
filterAndMap: (mapFilter) => filterAndMap(array, mapFilter),
|
|
166
174
|
sortBy: (sortByValue, props) => sortBy(array, sortByValue, props),
|
|
167
|
-
rejectDuplicates: (getKey) => rejectDuplicates(array, getKey)
|
|
175
|
+
rejectDuplicates: (getKey) => rejectDuplicates(array, getKey),
|
|
176
|
+
findAndMap: (predicate) => findAndMap(array, predicate)
|
|
168
177
|
};
|
|
169
178
|
}
|
|
170
179
|
// Annotate the CommonJS export names for ESM import in node:
|
|
@@ -174,6 +183,7 @@ function arrayOps(array) {
|
|
|
174
183
|
arrayWithPrevAndIndex,
|
|
175
184
|
filterAndMap,
|
|
176
185
|
findAfterIndex,
|
|
186
|
+
findAndMap,
|
|
177
187
|
findBeforeIndex,
|
|
178
188
|
getAscIndexOrder,
|
|
179
189
|
hasDuplicates,
|
package/dist/arrayUtils.d.cts
CHANGED
|
@@ -94,7 +94,26 @@ type ArrayOps<T> = {
|
|
|
94
94
|
filterAndMap: <R>(mapFilter: (item: T, index: number) => false | R) => R[];
|
|
95
95
|
sortBy: (sortByValue: SortByValue<T>, props: SortByProps) => T[];
|
|
96
96
|
rejectDuplicates: (getKey: (item: T) => unknown) => T[];
|
|
97
|
+
findAndMap: <R>(predicate: (value: T) => R | false) => R | undefined;
|
|
97
98
|
};
|
|
99
|
+
/**
|
|
100
|
+
* Finds the first item in an array where the predicate returns a non-false value and returns that mapped value.
|
|
101
|
+
*
|
|
102
|
+
* Combines find and map operations - applies the predicate to each item until one returns
|
|
103
|
+
* a value that is not `false`, then returns that mapped value. If no item matches, returns `undefined`.
|
|
104
|
+
*
|
|
105
|
+
* @param array - The array to search through
|
|
106
|
+
* @param predicate - Function that returns a mapped value or `false` to skip the item
|
|
107
|
+
* @returns The first mapped value that is not `false`, or `undefined` if no item matches
|
|
108
|
+
* @example
|
|
109
|
+
* const users = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
|
|
110
|
+
*
|
|
111
|
+
* const foundName = findAndMap(users, (user) =>
|
|
112
|
+
* user.id === 2 ? user.name.toUpperCase() : false
|
|
113
|
+
* );
|
|
114
|
+
* // foundName is 'BOB'
|
|
115
|
+
*/
|
|
116
|
+
declare function findAndMap<T, R>(array: T[], predicate: (value: T) => R | false): R | undefined;
|
|
98
117
|
/**
|
|
99
118
|
* Enhance an array with extra methods
|
|
100
119
|
*
|
|
@@ -109,4 +128,4 @@ type ArrayOps<T> = {
|
|
|
109
128
|
*/
|
|
110
129
|
declare function arrayOps<T>(array: T[]): ArrayOps<T>;
|
|
111
130
|
|
|
112
|
-
export { type FilterAndMapReturn, arrayOps, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findBeforeIndex, getAscIndexOrder, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };
|
|
131
|
+
export { type FilterAndMapReturn, arrayOps, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findAndMap, findBeforeIndex, getAscIndexOrder, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };
|
package/dist/arrayUtils.d.ts
CHANGED
|
@@ -94,7 +94,26 @@ type ArrayOps<T> = {
|
|
|
94
94
|
filterAndMap: <R>(mapFilter: (item: T, index: number) => false | R) => R[];
|
|
95
95
|
sortBy: (sortByValue: SortByValue<T>, props: SortByProps) => T[];
|
|
96
96
|
rejectDuplicates: (getKey: (item: T) => unknown) => T[];
|
|
97
|
+
findAndMap: <R>(predicate: (value: T) => R | false) => R | undefined;
|
|
97
98
|
};
|
|
99
|
+
/**
|
|
100
|
+
* Finds the first item in an array where the predicate returns a non-false value and returns that mapped value.
|
|
101
|
+
*
|
|
102
|
+
* Combines find and map operations - applies the predicate to each item until one returns
|
|
103
|
+
* a value that is not `false`, then returns that mapped value. If no item matches, returns `undefined`.
|
|
104
|
+
*
|
|
105
|
+
* @param array - The array to search through
|
|
106
|
+
* @param predicate - Function that returns a mapped value or `false` to skip the item
|
|
107
|
+
* @returns The first mapped value that is not `false`, or `undefined` if no item matches
|
|
108
|
+
* @example
|
|
109
|
+
* const users = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
|
|
110
|
+
*
|
|
111
|
+
* const foundName = findAndMap(users, (user) =>
|
|
112
|
+
* user.id === 2 ? user.name.toUpperCase() : false
|
|
113
|
+
* );
|
|
114
|
+
* // foundName is 'BOB'
|
|
115
|
+
*/
|
|
116
|
+
declare function findAndMap<T, R>(array: T[], predicate: (value: T) => R | false): R | undefined;
|
|
98
117
|
/**
|
|
99
118
|
* Enhance an array with extra methods
|
|
100
119
|
*
|
|
@@ -109,4 +128,4 @@ type ArrayOps<T> = {
|
|
|
109
128
|
*/
|
|
110
129
|
declare function arrayOps<T>(array: T[]): ArrayOps<T>;
|
|
111
130
|
|
|
112
|
-
export { type FilterAndMapReturn, arrayOps, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findBeforeIndex, getAscIndexOrder, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };
|
|
131
|
+
export { type FilterAndMapReturn, arrayOps, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findAndMap, findBeforeIndex, getAscIndexOrder, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };
|
package/dist/arrayUtils.js
CHANGED
|
@@ -4,6 +4,7 @@ import {
|
|
|
4
4
|
arrayWithPrevAndIndex,
|
|
5
5
|
filterAndMap,
|
|
6
6
|
findAfterIndex,
|
|
7
|
+
findAndMap,
|
|
7
8
|
findBeforeIndex,
|
|
8
9
|
getAscIndexOrder,
|
|
9
10
|
hasDuplicates,
|
|
@@ -12,7 +13,7 @@ import {
|
|
|
12
13
|
rejectDuplicates,
|
|
13
14
|
sortBy,
|
|
14
15
|
truncateArray
|
|
15
|
-
} from "./chunk-
|
|
16
|
+
} from "./chunk-27AL66CH.js";
|
|
16
17
|
import "./chunk-C2SVCIWE.js";
|
|
17
18
|
import "./chunk-JF2MDHOJ.js";
|
|
18
19
|
export {
|
|
@@ -21,6 +22,7 @@ export {
|
|
|
21
22
|
arrayWithPrevAndIndex,
|
|
22
23
|
filterAndMap,
|
|
23
24
|
findAfterIndex,
|
|
25
|
+
findAndMap,
|
|
24
26
|
findBeforeIndex,
|
|
25
27
|
getAscIndexOrder,
|
|
26
28
|
hasDuplicates,
|
|
@@ -118,11 +118,19 @@ function truncateArray(array, maxLength, appendIfTruncated) {
|
|
|
118
118
|
}
|
|
119
119
|
return result;
|
|
120
120
|
}
|
|
121
|
+
function findAndMap(array, predicate) {
|
|
122
|
+
for (const item of array) {
|
|
123
|
+
const value = predicate(item);
|
|
124
|
+
if (value !== false) return value;
|
|
125
|
+
}
|
|
126
|
+
return void 0;
|
|
127
|
+
}
|
|
121
128
|
function arrayOps(array) {
|
|
122
129
|
return {
|
|
123
130
|
filterAndMap: (mapFilter) => filterAndMap(array, mapFilter),
|
|
124
131
|
sortBy: (sortByValue, props) => sortBy(array, sortByValue, props),
|
|
125
|
-
rejectDuplicates: (getKey) => rejectDuplicates(array, getKey)
|
|
132
|
+
rejectDuplicates: (getKey) => rejectDuplicates(array, getKey),
|
|
133
|
+
findAndMap: (predicate) => findAndMap(array, predicate)
|
|
126
134
|
};
|
|
127
135
|
}
|
|
128
136
|
|
|
@@ -139,5 +147,6 @@ export {
|
|
|
139
147
|
hasDuplicates,
|
|
140
148
|
rejectDuplicates,
|
|
141
149
|
truncateArray,
|
|
150
|
+
findAndMap,
|
|
142
151
|
arrayOps
|
|
143
152
|
};
|
package/dist/concurrentCalls.js
CHANGED
package/dist/serializeXML.js
CHANGED
package/dist/testUtils.js
CHANGED
|
@@ -11,7 +11,7 @@ import {
|
|
|
11
11
|
} from "./chunk-JQFUKJU5.js";
|
|
12
12
|
import {
|
|
13
13
|
filterObjectOrArrayKeys
|
|
14
|
-
} from "./chunk-
|
|
14
|
+
} from "./chunk-6CG6JZKB.js";
|
|
15
15
|
import {
|
|
16
16
|
defer
|
|
17
17
|
} from "./chunk-DFXNVEH6.js";
|
|
@@ -22,7 +22,7 @@ import "./chunk-KW55OTUG.js";
|
|
|
22
22
|
import {
|
|
23
23
|
arrayWithPrevAndIndex,
|
|
24
24
|
filterAndMap
|
|
25
|
-
} from "./chunk-
|
|
25
|
+
} from "./chunk-27AL66CH.js";
|
|
26
26
|
import {
|
|
27
27
|
isObject
|
|
28
28
|
} from "./chunk-C2SVCIWE.js";
|
|
@@ -63,6 +63,30 @@ const enhancedItems = arrayOps(items);
|
|
|
63
63
|
enhancedItems.filterAndMap((item) => item === 2 ? false : item);
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
+
##### findAndMap()
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
findAndMap: <R>(predicate) => R | undefined;
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Defined in: [packages/utils/src/arrayUtils.ts:275](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L275)
|
|
73
|
+
|
|
74
|
+
###### Type Parameters
|
|
75
|
+
|
|
76
|
+
###### R
|
|
77
|
+
|
|
78
|
+
`R`
|
|
79
|
+
|
|
80
|
+
###### Parameters
|
|
81
|
+
|
|
82
|
+
###### predicate
|
|
83
|
+
|
|
84
|
+
(`value`) => `R` \| `false`
|
|
85
|
+
|
|
86
|
+
###### Returns
|
|
87
|
+
|
|
88
|
+
`R` \| `undefined`
|
|
89
|
+
|
|
66
90
|
##### rejectDuplicates()
|
|
67
91
|
|
|
68
92
|
```ts
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:42](https://github.com/lucasols/ut
|
|
|
34
34
|
function arrayOps<T>(array): ArrayOps<T>;
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/utils/src/arrayUtils.ts:
|
|
37
|
+
Defined in: [packages/utils/src/arrayUtils.ts:318](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L318)
|
|
38
38
|
|
|
39
39
|
Enhance an array with extra methods
|
|
40
40
|
|
|
@@ -209,6 +209,62 @@ Defined in: [packages/utils/src/arrayUtils.ts:165](https://github.com/lucasols/u
|
|
|
209
209
|
|
|
210
210
|
***
|
|
211
211
|
|
|
212
|
+
### findAndMap()
|
|
213
|
+
|
|
214
|
+
```ts
|
|
215
|
+
function findAndMap<T, R>(array, predicate): undefined | R;
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
Defined in: [packages/utils/src/arrayUtils.ts:295](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L295)
|
|
219
|
+
|
|
220
|
+
Finds the first item in an array where the predicate returns a non-false value and returns that mapped value.
|
|
221
|
+
|
|
222
|
+
Combines find and map operations - applies the predicate to each item until one returns
|
|
223
|
+
a value that is not `false`, then returns that mapped value. If no item matches, returns `undefined`.
|
|
224
|
+
|
|
225
|
+
#### Type Parameters
|
|
226
|
+
|
|
227
|
+
##### T
|
|
228
|
+
|
|
229
|
+
`T`
|
|
230
|
+
|
|
231
|
+
##### R
|
|
232
|
+
|
|
233
|
+
`R`
|
|
234
|
+
|
|
235
|
+
#### Parameters
|
|
236
|
+
|
|
237
|
+
##### array
|
|
238
|
+
|
|
239
|
+
`T`[]
|
|
240
|
+
|
|
241
|
+
The array to search through
|
|
242
|
+
|
|
243
|
+
##### predicate
|
|
244
|
+
|
|
245
|
+
(`value`) => `false` \| `R`
|
|
246
|
+
|
|
247
|
+
Function that returns a mapped value or `false` to skip the item
|
|
248
|
+
|
|
249
|
+
#### Returns
|
|
250
|
+
|
|
251
|
+
`undefined` \| `R`
|
|
252
|
+
|
|
253
|
+
The first mapped value that is not `false`, or `undefined` if no item matches
|
|
254
|
+
|
|
255
|
+
#### Example
|
|
256
|
+
|
|
257
|
+
```ts
|
|
258
|
+
const users = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
|
|
259
|
+
|
|
260
|
+
const foundName = findAndMap(users, (user) =>
|
|
261
|
+
user.id === 2 ? user.name.toUpperCase() : false
|
|
262
|
+
);
|
|
263
|
+
// foundName is 'BOB'
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
***
|
|
267
|
+
|
|
212
268
|
### findBeforeIndex()
|
|
213
269
|
|
|
214
270
|
```ts
|