rubico 2.5.0 → 2.6.0

package/_internal/arrayMapPool.js

@@ -11,27 +11,26 @@ const promiseRace = require('./promiseRace')
  * arrayMapPoolAsync<
  *   T any,
  *   array Array<T>,
- *   mapper T=>Promise|any,
+ *   f T=>Promise|any,
  *   concurrencyLimit number,
  *   result Array,
  *   index number,
  *   promises Set<Promise>,
- * >(array, mapper, concurrencyLimit, result, index, promises) -> result
+ * >(array, f, concurrencyLimit, result, index, promises) -> result
  * ```
  *
  * @description
- * Apply a mapper with limited concurrency to each item of an array, returning a Promise of an array of results.
+ * Apply a function `f` with limited concurrency to each item of an array, returning a Promise of an array of results.
  */
 const arrayMapPoolAsync = async function (
-  array, mapper, concurrencyLimit, result, index, promises,
+  array, f, concurrencyLimit, result, index, promises,
 ) {
   const arrayLength = array.length
   while (++index < arrayLength) {
     if (promises.size >= concurrencyLimit) {
       await promiseRace(promises)
     }
-
-    const resultItem = mapper(array[index])
+    const resultItem = f(array[index])
     if (isPromise(resultItem)) {
       const selfDeletingPromise = resultItem.then(
         tapSync(() => promises.delete(selfDeletingPromise)))
@@ -45,29 +44,22 @@ const arrayMapPoolAsync = async function (
 }
 
 /**
- * @name
- * arrayMapPool
+ * @name arrayMapPool
  *
  * @synopsis
  * ```coffeescript [specscript]
- * arrayMapPool<
- *   T any,
- *   array Array<T>
- *   mapper T=>Promise|any,
- *   concurrentLimit number,
- * >(array, mapper, concurrentLimit) -> Promise|Array
+ * arrayMapPool(array Array, concurrency number, f function) -> Promise|string
  * ```
  *
  * @description
- * Apply a mapper with limited concurrency to each item of an array, returning an array of results.
+ * Apply a function `f` with limited concurrency to each item of an array, returning an array of results.
  */
-const arrayMapPool = function (array, mapper, concurrentLimit) {
+const arrayMapPool = function (array, concurrency, f) {
   const arrayLength = array.length,
     result = Array(arrayLength)
   let index = -1
   while (++index < arrayLength) {
-
-    const resultItem = mapper(array[index])
+    const resultItem = f(array[index])
     if (isPromise(resultItem)) {
       const promises = new Set(),
         selfDeletingPromise = resultItem.then(
@@ -75,7 +67,7 @@ const arrayMapPool = function (array, mapper, concurrentLimit) {
       promises.add(selfDeletingPromise)
       result[index] = selfDeletingPromise
       return arrayMapPoolAsync(
-        array, mapper, concurrentLimit, result, index, promises)
+        array, f, concurrency, result, index, promises)
     }
     result[index] = resultItem
   }

package/_internal/mapMapPool.js

@@ -0,0 +1,80 @@
+const isPromise = require('./isPromise')
+const promiseRace = require('./promiseRace')
+const promiseAll = require('./promiseAll')
+const symbolIterator = require('./symbolIterator')
+
+/**
+ * @name _mapMapPoolAsync
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * _mapMapPoolAsync(
+ *   m Map,
+ *   iterator Iterator,
+ *   concurrency number,
+ *   f function,
+ *   result Map,
+ *   promises Set,
+ * ) -> Promise<Map>
+ * ```
+ */
+const _mapMapPoolAsync = async function (
+  m, iterator, concurrency, f, result, promises,
+) {
+  let iteration = iterator.next()
+  while (!iteration.done) {
+    if (promises.size >= concurrency) {
+      await promiseRace(promises)
+    }
+    const key = iteration.value[0]
+    const resultItem = f(iteration.value[1], key, m)
+    if (isPromise(resultItem)) {
+      result.set(key, resultItem)
+      const selfDeletingPromise = resultItem.then(resolvedValue => {
+        promises.delete(selfDeletingPromise)
+        result.set(key, resolvedValue)
+      })
+      promises.add(selfDeletingPromise)
+    } else {
+      result.set(key, resultItem)
+    }
+    iteration = iterator.next()
+  }
+  if (promises.size > 0) {
+    await promiseAll(promises)
+  }
+  return result
+}
+
+/**
+ * @name mapMapPool
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * mapMapPool(m Map, concurrency number, f function) -> Promise|Map
+ * ```
+ */
+const mapMapPool = function (m, concurrency, f) {
+  const result = new Map()
+  const iterator = m[symbolIterator]()
+  let iteration = iterator.next()
+  while (!iteration.done) {
+    const key = iteration.value[0]
+    const resultItem = f(iteration.value[1], key, m)
+    if (isPromise(resultItem)) {
+      const promises = new Set()
+      result.set(key, resultItem)
+      const selfDeletingPromise = resultItem.then(resolvedValue => {
+        promises.delete(selfDeletingPromise)
+        result.set(key, resolvedValue)
+      })
+      promises.add(selfDeletingPromise)
+      return _mapMapPoolAsync(m, iterator, concurrency, f, result, promises)
+    }
+    result.set(key, resultItem)
+    iteration = iterator.next()
+  }
+  return result
+}
+
+module.exports = mapMapPool

package/_internal/objectMapPool.js

@@ -0,0 +1,77 @@
+const isPromise = require('./isPromise')
+const promiseRace = require('./promiseRace')
+const promiseAll = require('./promiseAll')
+
+/**
+ * @name _objectMapPoolAsync
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * _objectMapPoolAsync(
+ *   o Object,
+ *   concurrency number,
+ *   f function,
+ *   result Object,
+ *   doneKeys Object,
+ *   promises Set,
+ * ) -> result Promise|Object
+ * ```
+ */
+const _objectMapPoolAsync = async function (
+  o, concurrency, f, result, doneKeys, promises,
+) {
+  for (const key in o) {
+    if (key in doneKeys) {
+      continue
+    }
+    if (promises.size >= concurrency) {
+      await promiseRace(promises)
+    }
+    const resultItem = f(o[key], key, o)
+    if (isPromise(resultItem)) {
+      result[key] = resultItem
+      const selfDeletingPromise = resultItem.then(resolvedValue => {
+        promises.delete(selfDeletingPromise)
+        result[key] = resolvedValue
+      })
+      promises.add(selfDeletingPromise)
+    } else {
+      result[key] = resultItem
+    }
+  }
+  if (promises.size > 0) {
+    await promiseAll(promises)
+  }
+  return result
+}
+
+/**
+ * @name objectMapPool
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * objectMapPool(o Object, concurrency number, f function) -> Promise|Object
+ * ```
+ */
+const objectMapPool = function (o, concurrency, f) {
+  const result = {}
+  const doneKeys = {}
+  for (const key in o) {
+    doneKeys[key] = true
+    const resultItem = f(o[key], key, o)
+    if (isPromise(resultItem)) {
+      const promises = new Set()
+      result[key] = resultItem
+      const selfDeletingPromise = resultItem.then(resolvedValue => {
+        promises.delete(selfDeletingPromise)
+        result[key] = resolvedValue
+      })
+      promises.add(selfDeletingPromise)
+      return _objectMapPoolAsync(o, concurrency, f, result, doneKeys, promises)
+    }
+    result[key] = resultItem
+  }
+  return result
+}
+
+module.exports = objectMapPool

package/_internal/objectMapSeries.js

@@ -54,6 +54,7 @@ const objectMapSeries = function (object, f) {
         thunkify4(_objectMapSeriesAsync, object, f, result, doneKeys),
       ))
     }
+    result[key] = resultItem
   }
   return result
 }

package/_internal/setMapPool.js

@@ -0,0 +1,79 @@
+const isPromise = require('./isPromise')
+const promiseRace = require('./promiseRace')
+const promiseAll = require('./promiseAll')
+const symbolIterator = require('./symbolIterator')
+
+/**
+ * @name _setMapPoolAsync
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * _setMapPoolAsync(
+ *   s Set,
+ *   iterator Iterator,
+ *   concurrency number,
+ *   f function,
+ *   result Set,
+ *   promises Set,
+ * ) -> result Promise<Set>
+ * ```
+ */
+const _setMapPoolAsync = async function (
+  s, iterator, concurrency, f, result, promises,
+) {
+  let iteration = iterator.next()
+  while (!iteration.done) {
+    if (promises.size >= concurrency) {
+      await promiseRace(promises)
+    }
+    const resultItem = f(iteration.value, iteration.value, s)
+    if (isPromise(resultItem)) {
+      const selfDeletingPromise = resultItem.then(resolvedValue => {
+        promises.delete(selfDeletingPromise)
+        result.add(resolvedValue)
+      })
+      promises.add(selfDeletingPromise)
+    } else {
+      result.add(resultItem)
+    }
+    iteration = iterator.next()
+  }
+  if (promises.size > 0) {
+    await promiseAll(promises)
+  }
+  return result
+}
+
+/**
+ * @name setMapPool
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * setMapPool(s Set, concurrency number, f function) -> Promise|Set
+ * ```
+ *
+ * @description
+ * Apply a function `f` with limited concurrency to each item of a set `s`, returning an array of results.
+ */
+const setMapPool = function (s, concurrency, f) {
+  const result = new Set()
+  const iterator = s[symbolIterator]()
+  let iteration = iterator.next()
+  while (!iteration.done) {
+    const resultItem = f(iteration.value, iteration.value, s)
+    if (isPromise(resultItem)) {
+      const promises = new Set()
+      const selfDeletingPromise = resultItem.then(resolvedValue => {
+        promises.delete(selfDeletingPromise)
+        result.add(resolvedValue)
+      })
+      promises.add(selfDeletingPromise)
+      return _setMapPoolAsync(s, iterator, concurrency, f, result, promises)
+    }
+    result.add(resultItem)
+    iteration = iterator.next()
+  }
+  return result
+}
+
+module.exports = setMapPool

package/_internal/stringMapPool.js

@@ -0,0 +1,22 @@
+const isPromise = require('./isPromise')
+const curry3 = require('./curry3')
+const __ = require('./placeholder')
+const callPropUnary = require('./callPropUnary')
+const arrayMapPool = require('./arrayMapPool')
+
+/**
+ * @name stringMapPool
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * stringMapPool(s string, concurrency number, f function) -> Promise|string
+ * ```
+ */
+const stringMapPool = function (s, concurrency, f) {
+  const result = arrayMapPool(s, concurrency, f)
+  return isPromise(result)
+    ? result.then(curry3(callPropUnary, __, 'join', ''))
+    : result.join('')
+}
+
+module.exports = stringMapPool

package/all.js

@@ -23,7 +23,7 @@ const functionObjectAll = require('./_internal/functionObjectAll')
  * ```
  *
  * @description
- * Function executor and composer. Accepts either an array of functions or an object of functions as the values. Calls each function of the provided array or object in parallel with the provided arguments. Returns either an array or object of the results of the function executions.
+ * Function executor and composer. Accepts either an array of functions or an object of functions. Calls each function of the provided array or object in parallel with the provided arguments. Returns either an array or object of the execution results.
  *
  * ```javascript [playground]
  * const createArrayOfGreetingsFor = all([
@@ -72,6 +72,16 @@ const functionObjectAll = require('./_internal/functionObjectAll')
  * getAndLogUserById('1') // Got user {"_id":1,"name":"George"} by id 1
  * ```
  *
+ * Any promises passed in argument position are resolved for their values before further execution. This only applies to the eager version of the API.
+ *
+ * ```javascript [playground]
+ * all(Promise.resolve({ a: 1 }), [
+ *   obj => obj.a + 1,
+ *   obj => obj.a + 2,
+ *   obj => obj.a + 3,
+ * ]).then(console.log) // [2, 3, 4]
+ * ```
+ *
  * @execution concurrent
  */
 

package/and.js

@@ -131,6 +131,15 @@ const areAllPredicatesTruthy = function (args, predicates) {
  * ) // true
  * ```
  *
+ * Any promises passed in argument position are resolved for their values before further execution. This only applies to the eager version of the API.
+ *
+ * ```javascript [playground]
+ * and(Promise.resolve(5), [
+ *   n => n > 0,
+ *   n => n < 10,
+ * ]).then(console.log) // true
+ * ```
+ *
  * @execution series
  *
  * @note ...args slows down here by an order of magnitude

package/assign.js

@@ -18,7 +18,7 @@ const _assign = function (object, funcs) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * assign(object Object, resolvers Object<function>) -> result Promise|Object
+ * assign(object Promise|Object, resolvers Object<function>) -> result Promise|Object
  *
  * assign(resolvers Object<function>)(object Object) -> result Promise|Object
  * ```
@@ -55,6 +55,19 @@ const _assign = function (object, funcs) {
  * // { numbers: [1, 2, 3, 4, 5], total: 15 }
  * ```
  *
+ * Any promises passed in argument position are resolved for their values before further execution. This only applies to the eager version of the API.
+ *
+ * ```javascript [playground]
+ * assign(Promise.resolve({}), {
+ *   a() {
+ *     return 1
+ *   },
+ *   b() {
+ *     return 2
+ *   },
+ * }).then(console.log)
+ * ```
+ *
  * @execution concurrent
  */
 const assign = function (arg0, arg1) {

package/compose.js

@@ -27,6 +27,14 @@ const funcConcat = require('./_internal/funcConcat')
  *   compose(5, [f, g]),
  * ) // 16
  * ```
+ *
+ * Any promises passed in argument position are resolved for their values before further execution. This only applies to the eager version of the API.
+ *
+ * ```javascript [playground]
+ * compose(Promise.resolve(1), 2, Promise.resolve(3), [
+ *   console.log, // [1, 2, 3]
+ * ])
+ * ```
  */
 const compose = function (...args) {
   const funcs = args.pop()

package/dist/Transducer.es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/Transducer.es.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/Transducer.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/Transducer.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/Transducer.mjs

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/__.es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/__.es.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/__.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/__.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/__.mjs

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/all.es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/all.es.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/all.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/all.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/all.mjs

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/always.es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/always.es.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/always.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/always.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/always.mjs

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/and.es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/and.es.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/and.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/and.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/and.mjs

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/assign.es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/assign.es.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/assign.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.

package/dist/assign.min.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.5.0
+ * rubico v2.6.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2024 Richard Tong
  * rubico may be freely distributed under the MIT license.