feat: add breakFunc argument to use break in the “map” function

docs/async/map.mdx

@@ -19,4 +19,14 @@ const api = {
 const users = await _.map(userIds, async userId => {
   return await api.users.find(userId)
 }) // [true, true, false, false]
+
+const users = await _.map(
+  userIds,
+  async userId => {
+    return await api.users.find(userId)
+  },
+  user => {
+    return user === 3
+  },
+) // [true, true]
 ```

src/async/map.ts

@@ -16,14 +16,19 @@
 export async function map<T, K>(
   array: readonly T[],
   asyncMapFunc: (item: T, index: number) => Promise<K>,
+  breakFunc?: (result: Awaited<K>, item: T, index: number) => boolean,
 ): Promise<K[]> {
   if (!array) {
     return []
   }
   const result = []
   let index = 0
   for (const value of array) {
-    const newValue = await asyncMapFunc(value, index++)
+    const newValue = await asyncMapFunc(value, index)
+
+    if (breakFunc && breakFunc(newValue, value, index)) break
+
+    index++
     result.push(newValue)
   }
   return result

tests/async/map.test.ts

@@ -27,4 +27,14 @@ describe('map', () => {
     const result = await _.map(array, mapper)
     expect(result).toEqual(['a0', 'b1', 'c2', 'd3'])
   })
+
+  test('returns result with break', async () => {
+    const array = ['a', 'b', 'c', 'd']
+    const mapper = async (l: string, index: number) => `${l}${index}`
+    const breakFunc = (result: string, item: string, index: number) =>{
+     return item === 'c' && result === `${item}${index}`
+    }
+    const result = await _.map(array, mapper, breakFunc)
+    expect(result).toEqual(['a0', 'b1'])
+  })
 })