rubico 2.7.1 → 2.7.3

package/all.js

@@ -36,30 +36,27 @@ const _allValues = function (values) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * all(values Promise|Array<Promise|any>) -> result Promise|Array
- * all(values Promise|Object<Promise|any>) -> result Promise|Object
- *
- * all(
- *   ...args,
- *   resolversOrValues Array<function|Promise|any>
- * ) -> result Promise|Array
- *
- * all(
- *   resolversOrValues Array<function|Promise|any>
- * )(...args) -> result Promise|Array
- *
- * all(
- *   ...args,
- *   resolversOrValues Object<function|Promise|any>
- * ) -> result Promise|Object
- *
- * all(
- *   resolversOrValues Object<function|Promise|any>
- * )(...args) -> result Promise|Object
+ * args Array<any>
+ * argsOrPromises Array<Promise|any>
+ *
+ * type Resolver = (...args)=>Promise|any
+ *
+ * arrayResolversOrPromisesOrValues Array<Resolver|Promise|any>
+ * objectResolversOrPromisesOrValues Object<Resolver|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
  * ```
  *
  * @description
- * Calls an array or object of resolver functions or values `resolversOrValues` with provided arguments.
+ * 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.
  *
  * ```javascript [playground]
  * const createArrayOfGreetingsFor = all([
@@ -74,23 +71,25 @@ const _allValues = function (values) {
  * // ['Hi 1', 'Hey 1', 'Hello 1']
  * ```
  *
- * If provided only values for `resolversOrValues`, returns an array or object with the same shape as `resolversOrValues` with any Promises resolved.
+ * If any provided values are promises, `all` returns a promise.
  *
  * ```javascript [playground]
- * all([
+ * const promise1 = all([
  *   Promise.resolve(1),
  *   Promise.resolve(2),
  *   3,
- * ]).then(console.log) // [1, 2, 3]
+ * ])
+ * promise1.then(console.log) // [1, 2, 3]
  *
- * all({
- *   a: Promise.resolve(1),
+ * const promise2 = all({
+ *   a: 1,
  *   b: Promise.resolve(2),
- *   c: 3,
- * }).then(console.log) // { a: 1, b: 2, c: 3 }
+ *   c: Promise.resolve(3),
+ * })
+ * promise2.then(console.log) // { a: 1, b: 2, c: 3 }
  * ```
  *
- * `all` can be used in a pipeline to compose and manpulate data.
+ * If any provided resolvers are asynchronous, `all` returns a promise. `all` can be used in a pipeline to compose and manpulate data.
  *
  * ```javascript [playground]
  * const identity = value => value
@@ -113,7 +112,7 @@ const _allValues = function (values) {
  * getAndLogUserById('1') // Got user {"_id":1,"name":"John"} by id 1
  * ```
  *
- * Values may be provided along with functions, in which case they are set on the result object or array directly. If any of these values are promises, they are resolved for their values before being set on the result object or array.
+ * Provided no resolvers, `all` returns the constructed array or object.
  *
  * ```javascript [playground]
  * all({}, {

package/and.js

@@ -97,38 +97,49 @@ const areAllPredicatesTruthy = function (args, predicates) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * and(values Array<boolean>) -> result boolean
+ * args Array<any>
+ * argsOrPromises Array<Promise|any>
+ * predicatesOrValues Array<function|boolean|any>
  *
- * and(...args, predicatesOrValues Array<function|boolean>) -> Promise|boolean
- *
- * and(predicatesOrValues Array<function|boolean>)(...args) -> Promise|boolean
+ * and(values Array<boolean|any>) -> result boolean
+ * and(...argsOrPromises, predicatesOrValues) -> Promise|boolean
+ * and(predicatesOrValues)(...args) -> Promise|boolean
  * ```
  *
  * @description
- * Tests an array of boolean values, returning true if all boolean values are truthy.
+ * Function equivalent to the [logical AND](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Logical_AND) operator. Tests an array of predicate functions, promises, values, or a mix thereof.
+ *
+ * If provided an array of boolean values, `and` returns true if all boolean values are true.
  *
  * ```javascript [playground]
  * const oneIsLessThanThree = 1 < 3
  * const twoIsGreaterThanOne = 2 > 1
  * const threeIsEqualToThree = 3 === 3
  *
- * console.log(
- *   and([oneIsLessThanThree, twoIsGreaterThanOne, threeIsEqualToThree]),
- * ) // true
+ * const condition = and([
+ *   oneIsLessThanThree,
+ *   twoIsGreaterThanOne,
+ *   threeIsEqualToThree
+ * ])
+ * console.log(condition) // true
  * ```
  *
- * If any values in the array are synchronous or asynchronous predicate functions, `and` takes another argument to test concurrently against the predicate functions, returning true if all array values and resolved values from the predicates are truthy.
+ * If any predicate functions are provided in the array, `and` returns an aggregate predicate function that returns true for a given set of arguments if all provided predicate functions test true. If any provided predicate functions are asynchronous, the aggregate predicate function becomes asynchronous.
  *
  * ```javascript [playground]
  * const isOdd = number => number % 2 == 1
- *
  * const isPositive = number => number > 0
+ * const asyncIsLessThan3 = async number => number < 3
  *
- * const isLessThan3 = number => number < 3
+ * const aggregatePredicate = and([
+ *   true,
+ *   isOdd,
+ *   isPositive,
+ *   asyncIsLessThan3,
+ * ])
  *
- * console.log(
- *   and([isOdd, isPositive, isLessThan3])(1),
- * ) // true
+ * const condition = await aggregatePredicate(1)
+ * 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.

package/assign.js

@@ -18,33 +18,36 @@ const _assign = function (object, funcs) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * assign(
- *   o Promise|Object,
- *   resolversOrValues Object<function|Promise|any>
- * ) -> result Promise|Object
- *
- * assign(
- *   resolversOrValues Object<function|Promise|any>
- * )(o Object) -> result Promise|Object
+ * args Array<any>
+ *
+ * type Resolver = (...args)=>Promise|any
+ *
+ * objectResolversOrPromisesOrValues Object<Resolver|Promise|any>
+ *
+ * assign(argumentObject Promise|Object, objectResolversOrPromisesOrValues) -> resultObject
+ * assign(objectResolversOrPromisesOrValues)(argumentObject Object) -> resultObject
  * ```
  *
  * @description
- * Function executor and composer. Accepts an object of resolver functions or values and an object `o`. Creates a result object from the argument object, evaluates each resolver with the argument object, and assigns to the result object the evaluations at the corresponding resolver keys.
+ * 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`.
+ *
+ * If any values of `objectResolversOrPromisesOrValues` are resolvers, `assign` provides the `argumentObject` to those resolvers to resolve the values for assignment in `resultObject`.
  *
  * ```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 }
+ * // { number: 2, squared: 4, cubed: 8, n: 1 }
  *
  * console.log(assignSquaredAndCubed({ number: 3 }))
- * // { number: 3, squared: 9, cubed: 27 }
+ * // { number: 3, squared: 9, cubed: 27, n: 1 }
  * ```
  *
- * Any of the resolvers may be asynchronous and return Promises.
+ * If any of the resolvers in `objectResolversOrPromisesOrValues` are asynchronous, `assign` returns a promise of `resultObject`.
  *
  * ```javascript [playground]
  * const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
@@ -60,17 +63,6 @@ const _assign = function (object, funcs) {
  * // { numbers: [1, 2, 3, 4, 5], total: 15 }
  * ```
  *
- * Values passed in resolver position are set on the result object directly. If any of these values are promises, they are resolved for their values before being set on the result object.
- *
- * ```javascript [playground]
- * assign({}, {
- *   a: 1,
- *   b: Promise.resolve(2),
- *   c: () => 3,
- *   d: async o => Object.keys(o).length,
- * }).then(console.log) // { a: 1, b: 2, c: 3, d: 0 }
- * ```
- *
  * 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]

package/compose.js

@@ -12,12 +12,10 @@ const funcConcat = require('./_internal/funcConcat')
  * ```coffeescript [specscript]
  * funcs Array<function>
  * args Array<any>
- * argsWithPromises Array<Promise|any>
+ * argsOrPromises Array<Promise|any>
  *
  * compose(funcs)(...args) -> result Promise|any
- *
- * compose(...argsWithPromises, funcs) -> result Promise|any
- *
+ * compose(...argsOrPromises, funcs) -> result Promise|any
  * compose(...funcs)(...args) -> result Promise|any
  * ```
  *

package/dist/Transducer.es.js

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

package/dist/Transducer.es.min.js

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

package/dist/Transducer.js

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

package/dist/Transducer.min.js

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

package/dist/Transducer.mjs

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

package/dist/__.es.js

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

package/dist/__.es.min.js

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

package/dist/__.js

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

package/dist/__.min.js

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

package/dist/__.mjs

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

package/dist/all.es.js

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

package/dist/all.es.min.js

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

package/dist/all.js

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

package/dist/all.min.js

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

package/dist/all.mjs

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

package/dist/always.es.js

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

package/dist/always.es.min.js

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

package/dist/always.js

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

package/dist/always.min.js

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

package/dist/always.mjs

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

package/dist/and.es.js

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

package/dist/and.es.min.js

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

package/dist/and.js

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

package/dist/and.min.js

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

package/dist/and.mjs

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

package/dist/assign.es.js

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

package/dist/assign.es.min.js

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

package/dist/assign.js

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

package/dist/assign.min.js

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

package/dist/assign.mjs

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

package/dist/compose.es.js

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

package/dist/compose.es.min.js

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

package/dist/compose.js

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

package/dist/compose.min.js

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

package/dist/compose.mjs

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

package/dist/curry.es.js

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

package/dist/curry.es.min.js

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

package/dist/curry.js

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

package/dist/curry.min.js

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

package/dist/curry.mjs

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

package/dist/eq.es.js

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

package/dist/eq.es.min.js

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

package/dist/eq.js

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

package/dist/eq.min.js

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

package/dist/eq.mjs

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

package/dist/every.es.js

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

package/dist/every.es.min.js

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

package/dist/every.js

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