rubico 2.2.1 → 2.2.2

package/dist/x/trace.mjs

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

package/dist/x/unionWith.es.js

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

package/dist/x/unionWith.es.min.js

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

package/dist/x/unionWith.js

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

package/dist/x/unionWith.min.js

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

package/dist/x/unionWith.mjs

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

package/dist/x/uniq.es.js

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

package/dist/x/uniq.es.min.js

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

package/dist/x/uniq.js

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

package/dist/x/uniq.min.js

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

package/dist/x/uniq.mjs

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

package/dist/x/unless.es.js

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

package/dist/x/unless.es.min.js

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

package/dist/x/unless.js

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

package/dist/x/unless.min.js

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

package/dist/x/unless.mjs

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

package/dist/x/values.es.js

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

package/dist/x/values.es.min.js

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

package/dist/x/values.js

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

package/dist/x/values.min.js

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

package/dist/x/values.mjs

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

package/dist/x/when.es.js

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

package/dist/x/when.es.min.js

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

package/dist/x/when.js

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

package/dist/x/when.min.js

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

package/dist/x/when.mjs

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

package/eq.js

@@ -39,6 +39,15 @@ const equals = require('./_internal/equals')
  * }
  * ```
  *
+ * `eq` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe({ name: 'George' }, [
+ *   eq('George', get('name')),
+ *   console.log, // true
+ * ])
+ * ```
+ *
  * @execution concurrent
  */
 

package/es.js

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

package/every.js

@@ -55,11 +55,11 @@ const _every = function (collection, predicate) {
  * const isOdd = number => number % 2 == 1
  *
  * console.log(
- *   every(isOdd)([1, 2, 3, 4, 5]),
+ *   every([1, 2, 3, 4, 5], isOdd),
  * ) // false
  *
  * console.log(
- *   every(isOdd)([1, 3, 5]),
+ *   every([1, 3, 5], isOdd),
  * ) // true
  * ```
  *
@@ -70,7 +70,16 @@ const _every = function (collection, predicate) {
  *   yield 1; yield 2; yield 3; yield 4; yield 5
  * }
  *
- * every(async number => number < 6)(asyncNumbers()).then(console.log) // true
+ * every(asyncNumbers(), async number => number < 6).then(console.log) // true
+ * ```
+ *
+ * `every` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe([1, 2, 3], [
+ *   every(number => number < 5),
+ *   console.log, // true
+ * ])
  * ```
  *
  * @execution concurrent

package/filter.js

@@ -90,19 +90,15 @@ const _filter = function (value, predicate) {
  * @synopsis
  * ```coffeescript [specscript]
  * type Filterable = Array|Object|Set|Map|Iterator|AsyncIterator
+ *
  * type Predicate = (
  *   value any,
  *   indexOrKey? number|string,
  *   collection? Filterable,
  * )=>boolean
  *
- * filter(
- *   collection Filterable,
- *   predicate Predicate
- * ) -> result Promise|Filterable
- *
- * filter(predicate Predicate)(collection Filterable)
- *   -> result Promise|Filterable
+ * filter(collection Filterable, predicate Predicate) -> result Promise|Filterable
+ * filter(predicate Predicate)(collection Filterable) -> result Promise|Filterable
  * ```
  *
  * @description

package/flatMap.js

@@ -67,13 +67,14 @@ const _flatMap = function (value, flatMapper) {
  * type FlatMappable = Array|String|Set|Iterator|AsyncIterator
  * type Iterable = Iterable|AsyncIterable|Object<value any>
  *
- * flatMap(
- *   collection FlatMappable,
- *   flatMapper (item any)=>Promise|Iterable,
- * ) -> result Promise|FlatMappable
- *
- * flatMap(flatMapper (item any)=>Promise|Iterable)(collection FlatMappable)
- *   -> result Promise|FlatMappable
+ * type FlatMapper = (
+ *   item any,
+ *   indexOrKey string,
+ *   collection FlatMappable
+ * )=>Promise|FlatMappable
+ *
+ * flatMap(collection FlatMappable, flatMapper FlatMapper) -> result Promise|FlatMappable
+ * flatMap(flatMapper FlatMapper)(collection FlatMappable) -> result Promise|FlatMappable
  * ```
  *
  * @description

package/get.js

@@ -19,6 +19,12 @@ const _get = function (object, path, defaultValue) {
  * @synopsis
  * ```coffeescript [specscript]
  * get(
+ *   object Promise|Object,
+ *   path string|number|Array<string|number>,
+ *   defaultValue? function|any
+ * ) -> result Promise|Object
+ *
+ * get(
  *   path string|number|Array<string|number>,
  *   defaultValue? function|any
  * )(object Object) -> result Promise|Object
@@ -28,6 +34,16 @@ const _get = function (object, path, defaultValue) {
  * Accesses a property of an object given a path denoted by a string, number, or an array of string or numbers.
  *
  * ```javascript [playground]
+ * const obj = { hello: 'world' }
+ *
+ * console.log(get(obj, 'hello')) // world
+ * ```
+ *
+ * `get` supports a tacit API for composability
+ *
+ * ```javascript [playground]
+ * const obj = { hello: 'world' }
+ *
  * const getHello = get('hello')
  *
  * console.log(getHello({ hello: 'world' })) // world

package/gt.js

@@ -38,6 +38,15 @@ const greaterThan = require('./_internal/greaterThan')
  *
  * console.log(isOfLegalAge(juvenile)) // false
  * ```
+ *
+ * `gt` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe({ value: 1 }, [
+ *   gt(5, get('value')),
+ *   console.log, // true
+ * ])
+ * ```
  */
 const gt = ComparisonOperator(greaterThan)
 

package/gte.js

@@ -40,6 +40,15 @@ const greaterThanOrEqual = require('./_internal/greaterThanOrEqual')
  * console.log(isAtLeast100(100)) // true
  * console.log(isAtLeast100(101)) // true
  * ```
+ *
+ * `gte` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe({ value: 1 }, [
+ *   gte(1, get('value')),
+ *   console.log, // true
+ * ])
+ * ```
  */
 const gte = ComparisonOperator(greaterThanOrEqual)
 

package/index.js

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

package/lt.js

@@ -38,6 +38,15 @@ const lessThan = require('./_internal/lessThan')
  * console.log(isLessThan3(3)) // false
  * console.log(isLessThan3(5)) // false
  * ```
+ *
+ * `lt` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe({ value: 1 }, [
+ *   lt(0, get('value')),
+ *   console.log, // true
+ * ])
+ * ```
  */
 const lt = ComparisonOperator(lessThan)
 

package/lte.js

@@ -38,6 +38,15 @@ const lessThanOrEqual = require('./_internal/lessThanOrEqual')
  * console.log(isLessThanOrEqualTo3(3), true)
  * console.log(isLessThanOrEqualTo3(5), false)
  * ```
+ *
+ * `lte` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe({ value: 1 }, [
+ *   lte(1, get('value')),
+ *   console.log, // true
+ * ])
+ * ```
  */
 const lte = ComparisonOperator(lessThanOrEqual)
 

package/map.js

@@ -100,36 +100,29 @@ const _map = function (value, mapper) {
  * @synopsis
  * ```coffeescript [specscript]
  * arrayMapperFunc (value any, index number, array Array)=>Promise|any
+ * objectMapperFunc (value any, key string, object Object)=>Promise|any
+ * setMapperFunc (value any, value, set Set)=>Promise|any
+ * mapMapperFunc (value any, key any, originalMap Map)=>Promise|any
+ * iteratorMapperFunc (value any)=>any
+ * asyncIteratorMapperFunc (value any)=>Promise|any
  *
  * map(arrayMapperFunc)(value Array) -> result Promise|Array
  * map(value Array, arrayMapperFunc) -> result Promise|Array
  *
- * objectMapperFunc (value any, key string, object Object)=>Promise|any
- *
  * map(objectMapperFunc)(value Object) -> result Promise|Array
  * map(value Object, objectMapperFunc) -> result Promise|Array
  *
- * setMapperFunc (value any, value, set Set)=>Promise|any
- *
  * map(setMapperFunc)(value Set) -> result Promise|Set
  * map(value Set, setMapperFunc) -> result Promise|Set
  *
- * mapMapperFunc (value any, key any, originalMap Map)=>Promise|any
- *
  * map(mapMapperFunc)(value Map) -> result Promise|Map
  * map(value Map, mapMapperFunc) -> result Promise|Map
  *
- * iteratorMapperFunc (value any)=>any
- *
  * map(iteratorMapperFunc)(value Iterator|Generator) -> result Iterator
  * map(value Iterator|Generator, iteratorMapperFunc) -> result Iterator
  *
- * asyncIteratorMapperFunc (value any)=>Promise|any
- *
- * map(asyncIteratorMapperFunc)(value AsyncIterator|AsyncGenerator)
- *   -> result AsyncIterator
- * map(value AsyncIterator|AsyncGenerator, asyncIteratorMapperFunc)
- *   -> result AsyncIterator
+ * map(asyncIteratorMapperFunc)(value AsyncIterator) -> result AsyncIterator
+ * map(value AsyncIterator, asyncIteratorMapperFunc) -> result AsyncIterator
  * ```
  *
  * @description

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rubico",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "[a]synchronous functional programming",
   "author": "Richard Tong",
   "license": "MIT",

package/reduce.js

@@ -22,6 +22,7 @@ const _reduce = function (collection, reducer, initialValue) {
  * @synopsis
  * ```coffeescript [specscript]
  * type Foldable = Array|Object|Map|Iterator|AsyncIterator
+ *
  * type Reducer = (
  *   accumulator any,
  *   value any,

package/set.js

@@ -39,7 +39,7 @@ const _set = function (obj, path, value) {
  * @synopsis
  * ```coffeescript [specscript]
  * set(
- *   object Object,
+ *   object Promise|Object,
  *   path string|Array<string|number>,
  *   value function|any,
  * ) -> result Promise|Object
@@ -60,15 +60,15 @@ const _set = function (obj, path, value) {
  *  * an array of keys or indices - `['a', 0, 'value']`
  *
  * ```javascript [playground]
- * console.log(set('a', 1)({ b: 2 })) // { a: 1, b: 2 }
+ * console.log(set({ b: 2 }, 'a', 1)) // { a: 1, b: 2 }
  *
  * const nestedAC2 = { a: { c: 2 } }
  *
- * console.log(set('a.b', 1)(nestedAC2)) // { a : { b: 1, c: 2 }}
+ * console.log(set(nestedAC2, 'a.b', 1)) // { a : { b: 1, c: 2 }}
  *
  * const nestedA0BC3 = { a: [{ b: { c: 3 } }] }
  *
- * console.log(set('a[0].b.c', 4)(nestedA0BC3)) // { a: [{ b: { c: 4 } }] }
+ * console.log(set(nestedA0BC3, 'a[0].b.c', 4)) // { a: [{ b: { c: 4 } }] }
  * ```
  *
  * The property value may be a function, in which case it is treated as a resolver and provided the argument object to resolve the value to set.
@@ -81,6 +81,15 @@ const _set = function (obj, path, value) {
  * console.log(myNewObj) // { a: 1, b: 3 }
  * ```
  *
+ * `set` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe({ a: 1 }, [
+ *   set('b', 2),
+ *   console.log, // { a: 1, b: 2 }
+ * ])
+ * ```
+ *
  * @since 1.7.0
  */
 

package/some.js

@@ -75,10 +75,21 @@ const _some = function (collection, predicate) {
  *   yield 1; yield 2; yield 3; yield 4; yield 5
  * }
  *
- * some(pipe([
- *   fetchTodo,
- *   todo => todo.title.startsWith('fugiat'),
- * ]))(todoIDsGenerator()).then(console.log) // true
+ * const promise = some(todoIDsGenerator(), async id => {
+ *   const todo = await fetchTodo(id)
+ *   return todo.title.startsWith('fugiat')
+ * })
+ *
+ * promise.then(console.log) // true
+ * ```
+ *
+ * `some` supports a tacit API for composability.
+ *
+ * ```javascript [playground]
+ * pipe([1, 2, 3], [
+ *   some(number => number < 5),
+ *   console.log, // true
+ * ])
  * ```
  *
  * @execution concurrent

package/switchCase.js

@@ -15,12 +15,31 @@ const curryArgs3 = require('./_internal/curryArgs3')
  * switchCase(conditionalValues Array<boolean|any>) -> Promise|any
  *
  * switchCase(
+ *   ...args,
+ *   conditionalFuncsOrValues Array<function|boolean|any>
+ * ) -> Promise|any
+ *
+ * switchCase(
  *   conditionalFuncsOrValues Array<function|boolean|any>
  * )(...args) -> Promise|any
  * ```
  *
  * @description
- * Functional equivalent to the [Conditional (ternary) operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Conditional_Operator). Accepts an array of conditional functions that specifies cases as pairings of `predicate` and `resolver` functions with the exception of the last, default resolver. All functions are provided with the same arguments and executed in series. The result of a `switchCase` execution is either the result of the execution the last default resolver, or the result of the execution of the first resolver where the associated predicate tested truthy.
+ * Functional equivalent to the [Conditional (ternary) operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Conditional_Operator). Accepts an array of conditional functions that specifies cases as pairings of `predicate` and `resolver` functions with the exception of the last, default resolver. All functions are provided with the same arguments and executed in series. The result of a `switchCase` operation is either the result of the execution the last default resolver, or the result of the execution of the first resolver where the associated predicate tested true.
+ *
+ * ```javascript [playground]
+ * const fruitIsYellow = fruit => fruit.color == 'yellow'
+ *
+ * console.log(
+ *   switchCase({ name: 'plantain', color: 'yellow' }, [
+ *     fruitIsYellow,
+ *     fruit => fruit.name + ' is possibly a banana',
+ *     fruit => fruit.name + ' is probably not a banana',
+ *   ])
+ * ) // plantain is possibly a banana
+ * ```
+ *
+ * For composability `switchCase` supports a tacit API.
  *
  * ```javascript [playground]
  * const fruitIsYellow = fruit => fruit.color == 'yellow'
@@ -38,7 +57,7 @@ const curryArgs3 = require('./_internal/curryArgs3')
  * // apple is probably not a banana
  * ```
  *
- * Any function can be replaced with a nonfunction (object or primitive) value so that the value is treated as an already resolved value.
+ * Any function can be replaced with a nonfunction (object or primitive) value to be used directly in the operation.
  *
  * ```javascript [playground]
  * switchCase([

package/transform.js

@@ -26,8 +26,6 @@ const _transform = function (collection, transducer, initialValue) {
  * type Transformable = Array|String|Set|TypedArray|{ concat: function }|{ write: function }|Object
  * type Foldable = Iterable|AsyncIterable|Object<value any>
  *
- * initialValue Transformable|((foldable Foldable)=>Promise|Transformable)
- *
  * transform(
  *   foldable Foldable,
  *   transducer Transducer,
@@ -58,9 +56,9 @@ const _transform = function (collection, transducer, initialValue) {
  *
  * const isOdd = number => number % 2 == 1
  *
- * const squaredOdds = pipe([
- *   filter(isOdd),
- *   map(square),
+ * const squaredOdds = compose([
+ *   Transducer.filter(isOdd),
+ *   Transducer.map(square),
  * ])
  *
  * // transform arrays into arrays
@@ -96,7 +94,7 @@ const _transform = function (collection, transducer, initialValue) {
  *   },
  * }
  *
- * transform(map(square), Stdout)([1, 2, 3, 4, 5])
+ * transform(Transducer.map(square), Stdout)([1, 2, 3, 4, 5])
  * // 1
  * // 4
  * // 9
@@ -124,8 +122,10 @@ const _transform = function (collection, transducer, initialValue) {
  * }
  *
  * transform(
- *   map(pipe([square, toString])), process.stdout,
- * )(streamRandomInts()) // 9216576529289484980147613249169774446246768649...
+ *   streamRandomInts(),
+ *   Transducer.map(pipe([square, toString])),
+ *   process.stdout,
+ * ) // 9216576529289484980147613249169774446246768649...
  * ```
  *
  * @execution series