rubico 2.8.5 → 2.8.6

package/README.md

@@ -2,6 +2,7 @@
 ![rubico](https://raw.githubusercontent.com/a-synchronous/assets/master/rubico-logo.png)
 > a shallow river in northeastern Italy, just south of Ravenna
 
+Source code: [GitHub](https://github.com/a-synchronous/rubico) |
 License: [CFOSS](https://cloutsworld.com/en-us/legal/license/cfoss)
 
 ![Node.js CI](https://github.com/a-synchronous/rubico/workflows/Node.js%20CI/badge.svg)

package/_internal/curryArity.js

@@ -29,7 +29,7 @@ const _curryArity = (arity, func, context, args) => function curried(...curriedA
     curriedArgsIndex = -1,
     numCurriedPlaceholders = 0
 
-  while (++argsIndex < argsLength) {
+  while ((argsIndex += 1) < argsLength) {
     const arg = args[argsIndex]
     if (arg == __ && (curriedArgsIndex += 1) < curriedArgsLength) {
       const curriedArg = curriedArgs[curriedArgsIndex]
@@ -53,7 +53,7 @@ const _curryArity = (arity, func, context, args) => function curried(...curriedA
     }
   }
 
-  while (++curriedArgsIndex < curriedArgsLength) {
+  while ((curriedArgsIndex += 1) < curriedArgsLength) {
     const curriedArg = curriedArgs[curriedArgsIndex]
     if (curriedArg == __) {
       numCurriedPlaceholders += 1
@@ -103,7 +103,7 @@ const curryArity = function (arity, func, context, args) {
     return _curryArity(arity, func, context, args)
   }
   let argsIndex = -1
-  while (++argsIndex < argsLength) {
+  while ((argsIndex += 1) < argsLength) {
     const arg = args[argsIndex]
     if (arg == __) {
       return _curryArity(arity, func, context, args)

package/all.js

@@ -36,42 +36,35 @@ const _allValues = function (values) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * args Array<any>
- * argsOrPromises Array<Promise|any>
+ * type SyncOrAsyncResolver = (...arguments)=>Promise|any
+ * type ResolverOrValue = SyncOrAsyncResolver|Promise|any
  *
- * type SyncOrAsyncResolver = (...args)=>Promise|any
+ * all(Promise|Array<Promise|any>) -> Promise|Array
+ * all(...arguments, Array<ResolverOrValue>) -> Promise|Array
+ * all(Array<ResolverOrValue>)(...arguments) -> Promise|Array
  *
- * arrayResolversOrPromisesOrValues Array<SyncOrAsyncResolver|Promise|any>
- * objectResolversOrPromisesOrValues Object<SyncOrAsyncResolver|Promise|any>
- *
- * all(arrayValues Promise|Array<Promise|any>) -> arrayResult Promise|Array
- * all(...argsOrPromises, arrayResolversOrPromisesOrValues) -> arrayResult Promise|Array
- * all(arrayResolversOrPromisesOrValues)(...args) -> arrayResult Promise|Array
- *
- * all(objectValues Promise|Object<Promise|any>) -> objectResult Promise|Object
- * all(...argsOrPromises, objectResolversOrPromisesOrValues) -> objectResult Promise|Object
- * all(objectResolversOrPromisesOrValues)(...args) -> objectResult Promise|Object
+ * all(Promise|Object<Promise|any>) -> Promise|Object
+ * all(...arguments, Object<ResolverOrValue>) -> Promise|Object
+ * all(Object<ResolverOrValue>)(...arguments) -> Promise|Object
  * ```
  *
  * @description
- * Constructs an array if provided an array of resolvers, promises, values, or a mix thereof. Constructs an object if provided an object of resolvers, promises, values, or a mix thereof. If provided any resolvers, `all` returns a function that constructs the array or object. Otherwise, if none of the provided values in the array or object are functions, `all` returns the constructed array or object directly.
- *
- * `all` constructs an array from resolvers.
+ * Function composer and data constructor. Constructs an array if provided an array of resolvers, promises, or values. Constructs an object if provided an object of resolvers, promises, or values. `all` returns a constructor function if provided resolvers. Otherwise, `all` returns the constructed array or object directly.
  *
  * ```javascript [playground]
- * const createArrayOfGreetingsFor = all([
+ * const createArrayOfGreetings = all([
  *   name => `Hi ${name}`,
- *   name => `Hey ${name}`,
  *   name => `Hello ${name}`,
+ *   name => `Greetings ${name}`,
  * ])
  *
- * const arrayOfGreetingsFor1 = createArrayOfGreetingsFor('1')
+ * const arrayOfGreetings = createArrayOfGreetings('example')
  *
  * console.log(arrayOfGreetingsFor1)
- * // ['Hi 1', 'Hey 1', 'Hello 1']
+ * // ['Hi example', 'Hello example', 'Gretings example']
  * ```
  *
- * If any provided values are promises, `all` returns a promise.
+ * If provided promises, `all` resolves those promises and returns a promise of the resolved values.
  *
  * ```javascript [playground]
  * const promise1 = all([
@@ -79,23 +72,25 @@ const _allValues = function (values) {
  *   Promise.resolve(2),
  *   3,
  * ])
- * promise1.then(console.log) // [1, 2, 3]
+ *
+ * promise1.then(console.log)
  *
  * const promise2 = all({
  *   a: 1,
  *   b: Promise.resolve(2),
  *   c: Promise.resolve(3),
  * })
- * promise2.then(console.log) // { a: 1, b: 2, c: 3 }
+ *
+ * promise2.then(console.log)
  * ```
  *
- * If any provided resolvers are asynchronous, `all` returns a promise. `all` can be used in a pipeline to compose and manpulate data.
+ * If any resolvers provided to `all` are asynchronous, `all` returns a promise.
  *
  * ```javascript [playground]
  * const identity = value => value
  *
  * const userbase = new Map()
- * userbase.set('1', { _id: 1, name: 'John' })
+ * userbase.set('1', { id: 1, name: 'John' })
  *
  * const getUserByID = async id => userbase.get(id)
  *
@@ -109,35 +104,17 @@ const _allValues = function (values) {
  *   }),
  * ])
  *
- * getAndLogUserById('1') // Got user {"_id":1,"name":"John"} by id 1
+ * getAndLogUserById('1')
  * ```
  *
- * Provided no resolvers, `all` returns the constructed array or object.
- *
- * ```javascript [playground]
- * all({}, {
- *   a: Promise.resolve(1),
- *   b: 2,
- *   c: () => 3,
- *   d: async () => 4,
- * }).then(console.log) // { a: 1, b: 2, c: 3, d: 4 }
- *
- * all([], [
- *   Promise.resolve(1),
- *   2,
- *   () => 3,
- *   async () => 4,
- * ]).then(console.log) // [1, 2, 3, 4]
- * ```
- *
- * Any promises passed in argument position are resolved for their values before further execution. This only applies to the eager version of the API.
+ * Any promises passed in argument position are resolved for their values before further execution.
  *
  * ```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]
+ * ]).then(console.log)
  * ```
  *
  * See also:
@@ -186,9 +163,9 @@ const all = function (...args) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * all.series(...args, funcsArray Array<function>) -> result Promise|Array
+ * all.series(...arguments, Array<function>) -> Promise|Array
  *
- * all.series(funcsArray Array<function>)(...args) -> result Promise|Array
+ * all.series(Array<function>)(...arguments) -> Promise|Array
  * ```
  *
  * @description
@@ -197,15 +174,13 @@ const all = function (...args) {
  * ```javascript [playground]
  * const sleep = ms => () => new Promise(resolve => setTimeout(resolve, ms))
  *
- * all.series([
+ * all.series('hello', [
  *   greeting => console.log(greeting + ' world'),
  *   sleep(1000),
- *   greeting => console.log(greeting + ' mom'),
+ *   greeting => console.log(greeting + ' all'),
  *   sleep(1000),
  *   greeting => console.log(greeting + ' goodbye'),
- * ])('hello') // hello world
- *             // hello mom
- *             // hello goodbye
+ * ])
  * ```
  *
  * @execution series

package/and.js

@@ -145,7 +145,7 @@ const areAllPredicatesTruthy = function (args, predicates) {
  * console.log(condition) // 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.
+ * Any promises passed in argument position are resolved for their values before further execution.
  *
  * ```javascript [playground]
  * and(Promise.resolve(5), [

package/assign.js

@@ -18,36 +18,33 @@ const _assign = function (object, funcs) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * args Array<any>
- *
  * type UnarySyncOrAsyncResolver = any=>Promise|any
  *
- * objectResolversOrPromisesOrValues Object<UnarySyncOrAsyncResolver|Promise|any>
- *
- * assign(argumentObject Promise|Object, objectResolversOrPromisesOrValues) -> resultObject
- * assign(objectResolversOrPromisesOrValues)(argumentObject Object) -> resultObject
+ * assign(Promise|Object, Object<UnarySyncOrAsyncResolver|Promise|any>) -> Promise|Object
+ * assign(Object<UnarySyncOrAsyncResolver|Promise|any>)(Object) -> Promise|Object
  * ```
  *
  * @description
- * Function equivalent to [Object.assign](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign). Constructs an object `result` from an object `objectResolversOrPromisesOrValues` of resolvers, promises, values, or a mix thereof and an argument object `argumentObject`.
+ * Function composer and data constructor. Constructs a new object from an argument object and an object of resolvers, promises, or values.
  *
- * If any values of `objectResolversOrPromisesOrValues` are resolvers, `assign` provides the `argumentObject` to those resolvers to resolve the values for assignment in `resultObject`.
+ * If provided resolver functions, `assign` resolves the values to be assigned at the keys of the resolver functions in the new object by calling those resolvers with the argument object.
  *
  * ```javascript [playground]
  * const assignSquaredAndCubed = assign({
  *   squared: ({ number }) => number ** 2,
  *   cubed: ({ number }) => number ** 3,
- *   n: 1,
  * })
  *
  * console.log(assignSquaredAndCubed({ number: 2 }))
- * // { number: 2, squared: 4, cubed: 8, n: 1 }
- *
  * console.log(assignSquaredAndCubed({ number: 3 }))
- * // { number: 3, squared: 9, cubed: 27, n: 1 }
+ *
+ * const n = 1
+ * const assignN = assign({ n })
+ *
+ * console.log(assignN({}))
  * ```
  *
- * If any of the resolvers in `objectResolversOrPromisesOrValues` are asynchronous, `assign` returns a promise of `resultObject`.
+ * If any of the resolvers provided to `assign` are asynchronous, the execution of `assign` with the argument object returns a promise.
  *
  * ```javascript [playground]
  * const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
@@ -59,11 +56,12 @@ const _assign = function (object, funcs) {
  *   },
  * })
  *
- * asyncAssignTotal({ numbers: [1, 2, 3, 4, 5] }).then(console.log)
- * // { numbers: [1, 2, 3, 4, 5], total: 15 }
+ * const promise = asyncAssignTotal({ numbers: [1, 2, 3, 4, 5] })
+ *
+ * promise.then(console.log)
  * ```
  *
- * Any promises passed in argument position are resolved for their values before further execution. This only applies to the eager version of the API.
+ * Any promises passed in argument position are resolved for their values before further execution.
  *
  * ```javascript [playground]
  * assign(Promise.resolve({}), {

package/compose.js

@@ -10,31 +10,30 @@ const funcConcat = require('./_internal/funcConcat')
  *
  * @synopsis
  * ```coffeescript [specscript]
- * args Array<any>
- * argsOrPromises Array<Promise|any>
- *
- * type SyncOrAsyncFunction = (...args)=>Promise|any
+ * type SyncOrAsyncFunction = (...arguments)=>Promise|any
  * type UnarySyncOrAsyncFunction = any=>Promise|any
  *
  * funcs [SyncOrAsyncFunction, ...Array<UnarySyncOrAsyncFunction>]
  *
- * compose(funcs)(...args) -> result Promise|any
- * compose(...argsOrPromises, funcs) -> result Promise|any
- * compose(...funcs)(...args) -> result Promise|any
+ * compose(funcs)(...arguments) -> Promise|any
+ * compose(...arguments, funcs) -> Promise|any
+ * compose(...funcs)(...arguments) -> Promise|any
  * ```
  *
  * @description
- * Creates a function composition from multiple functions. Each function in the composition is evaluated starting from the last function in the composition in series, passing its return value as an argument to the previous function. The result of a composition execution is the return value of the first function in the composition. All arguments provided to the composition are provided to the last function in the composition. If any function in the composition is asynchronous, the result of the composition execution is a Promise.
+ * Creates a function composition from multiple functions. Each function in the function composition is evaluated in series starting from the last function in the function composition, passing its return value as the first and only argument to the previous function in the function composition. The result of the execution of a function composition is the return value of the first function in the function composition. If any function in the function composition is asynchronous, the result of the execution of the function composition is a promise.
+ *
+ * Multiple arguments may be provided to a function composition, in which case they are passed directly to the last function in the function composition.
  *
  * ```javascript [playground]
  * const f = x => x * 2
  * const g = x => x + 3
  *
  * const result = compose(5, [f, g])
- * console.log(result) // 16
+ * console.log(result)
  * ```
  *
- * `compose` supports a mathematical API.
+ * Functions may be passed to `compose` as arguments instead of as items of an array.
  *
  * ```javascript [playground]
  * const f = x => x * 2
@@ -42,14 +41,14 @@ const funcConcat = require('./_internal/funcConcat')
  *
  * const composition = compose(f, g)
  *
- * console.log(composition(1)) // 4
+ * console.log(composition(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.
+ * Any promises passed in argument position are resolved for their values before further execution.
  *
  * ```javascript [playground]
  * compose(Promise.resolve(1), 2, Promise.resolve(3), [
- *   console.log, // [1, 2, 3]
+ *   console.log,
  * ])
  * ```
  *

package/curry.js

@@ -37,7 +37,7 @@ const curryArity = require('./_internal/curryArity')
  * console.log(curry(add, __, __, 'c')(__, 'b')('a'))
  * ```
  *
- * Any promises passed in argument position are resolved for their values before further execution. This only applies to the eager version of the API.
+ * Any promises passed in argument position are resolved for their values before further execution.
  *
  * ```javascript [playground]
  * const add = (a, b, c) => a + b + c

package/dist/Transducer.es.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/Transducer.es.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/Transducer.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/Transducer.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/Transducer.mjs

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/__.es.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/__.es.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/__.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/__.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/__.mjs

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/all.es.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/all.es.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/all.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/all.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/all.mjs

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/always.es.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/always.es.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/always.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/always.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/always.mjs

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/and.es.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/and.es.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/and.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/and.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/and.mjs

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/assign.es.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/assign.es.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/assign.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/assign.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/assign.mjs

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/compose.es.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/compose.es.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/compose.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/compose.min.js

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software

package/dist/compose.mjs

@@ -1,5 +1,5 @@
 /**
- * Rubico v2.8.5
+ * Rubico v2.8.6
  * https://rubico.land/
  *
  * © Richard Yufei Tong, King of Software