rubico 2.6.6 → 2.7.0

package/dist/x/prepend.min.js

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

package/dist/x/prepend.mjs

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

package/dist/x/size.es.js

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

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

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

package/dist/x/size.js

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

package/dist/x/size.min.js

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

package/dist/x/size.mjs

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

package/dist/x/trace.es.js

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

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

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

package/dist/x/trace.js

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

package/dist/x/trace.min.js

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

package/dist/x/trace.mjs

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

package/dist/x/unionWith.es.js

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

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

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

package/dist/x/unionWith.js

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

package/dist/x/unionWith.min.js

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

package/dist/x/unionWith.mjs

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

package/dist/x/uniq.es.js

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

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

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

package/dist/x/uniq.js

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

package/dist/x/uniq.min.js

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

package/dist/x/uniq.mjs

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

package/dist/x/unless.es.js

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

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

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

package/dist/x/unless.js

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

package/dist/x/unless.min.js

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

package/dist/x/unless.mjs

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

package/dist/x/values.es.js

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

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

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

package/dist/x/values.js

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

package/dist/x/values.min.js

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

package/dist/x/values.mjs

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

package/dist/x/when.es.js

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

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

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

package/dist/x/when.js

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

package/dist/x/when.min.js

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

package/dist/x/when.mjs

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

package/eq.d.ts

@@ -20,7 +20,7 @@ export = eq;
  * Test for [equality (`==`)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Equality) between two values.
  *
  * ```javascript [playground]
- * const areNamesEqual = eq('Ted', 'George')
+ * const areNamesEqual = eq('Ted', 'John')
  *
  * console.log(areNamesEqual) // false
  * ```
@@ -28,11 +28,11 @@ export = eq;
  * If either of the two values are resolver functions, `eq` returns a function that resolves the values to compare from its arguments.
  *
  * ```javascript [playground]
- * const personIsGeorge = eq(get('name'), 'George')
+ * const personIsJohn = eq(get('name'), 'John')
  *
- * const person = { name: 'George', likes: 'bananas' }
+ * const person = { name: 'John', likes: 'bananas' }
  *
- * if (personIsGeorge(person)) {
+ * if (personIsJohn(person)) {
  *   console.log('The person is george')
  * }
  * ```
@@ -40,8 +40,8 @@ export = eq;
  * `eq` supports a lazy API for composability.
  *
  * ```javascript [playground]
- * pipe({ name: 'George' }, [
- *   eq('George', get('name')),
+ * pipe({ name: 'John' }, [
+ *   eq('John', get('name')),
  *   console.log, // true
  * ])
  * ```

package/eq.js

@@ -22,7 +22,7 @@ const equals = require('./_internal/equals')
  * Test for [equality (`==`)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Equality) between two values.
  *
  * ```javascript [playground]
- * const areNamesEqual = eq('Ted', 'George')
+ * const areNamesEqual = eq('Ted', 'John')
  *
  * console.log(areNamesEqual) // false
  * ```
@@ -30,11 +30,11 @@ const equals = require('./_internal/equals')
  * If either of the two values are resolver functions, `eq` returns a function that resolves the values to compare from its arguments.
  *
  * ```javascript [playground]
- * const personIsGeorge = eq(get('name'), 'George')
+ * const personIsJohn = eq(get('name'), 'John')
  *
- * const person = { name: 'George', likes: 'bananas' }
+ * const person = { name: 'John', likes: 'bananas' }
  *
- * if (personIsGeorge(person)) {
+ * if (personIsJohn(person)) {
  *   console.log('The person is george')
  * }
  * ```
@@ -42,8 +42,8 @@ const equals = require('./_internal/equals')
  * `eq` supports a lazy API for composability.
  *
  * ```javascript [playground]
- * pipe({ name: 'George' }, [
- *   eq('George', get('name')),
+ * pipe({ name: 'John' }, [
+ *   eq('John', get('name')),
  *   console.log, // true
  * ])
  * ```
@@ -54,6 +54,14 @@ const equals = require('./_internal/equals')
  * eq(Promise.resolve({ a: 1, b: 1 }), get('a'), get('b')).then(console.log) // true
  * ```
  *
+ * See also:
+ *  * [and](/docs/and)
+ *  * [gt](/docs/gt)
+ *  * [lt](/docs/lt)
+ *  * [gte](/docs/gte)
+ *  * [lte](/docs/lte)
+ *  * [thunkify](/docs/thunkify)
+ *
  * @execution concurrent
  */
 

package/es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.6.6
+ * rubico v2.7.0
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2025 Richard Tong
  * rubico may be freely distributed under the MIT license.
@@ -67,6 +67,10 @@ const curry2 = function (baseFunc, arg0, arg1) {
 }
 
 const pipe = function (...args) {
+  if (typeof args[0] == 'function') {
+    return args.reduce(funcConcat)
+  }
+
   const funcs = args.pop()
   const pipeline = funcs.reduce(funcConcat)
 
@@ -82,6 +86,10 @@ const pipe = function (...args) {
 }
 
 const compose = function (...args) {
+  if (typeof args[0] == 'function') {
+    return args.reduceRight(funcConcat)
+  }
+
   const funcs = args.pop()
   const composition = funcs.reduceRight(funcConcat)
 
@@ -1739,17 +1747,17 @@ const genericReduce = function (collection, reducer, result) {
     : reducer(result, collection)
 }
 
-// _reduce(collection any, reducer function, initialValue function|any) -> Promise
-const _reduce = function (collection, reducer, initialValue) {
-  if (typeof initialValue == 'function') {
-    const actualInitialValue = initialValue(collection)
+// _reduce(collection any, reducer function, initial function|any) -> Promise
+const _reduce = function (collection, reducer, initial) {
+  if (typeof initial == 'function') {
+    const actualInitialValue = initial(collection)
     return isPromise(actualInitialValue)
       ? actualInitialValue.then(curry3(genericReduce, collection, reducer, __))
       : genericReduce(collection, reducer, actualInitialValue)
   }
-  return isPromise(initialValue)
-    ? initialValue.then(curry3(genericReduce, collection, reducer, __))
-    : genericReduce(collection, reducer, initialValue)
+  return isPromise(initial)
+    ? initial.then(curry3(genericReduce, collection, reducer, __))
+    : genericReduce(collection, reducer, initial)
 }
 
 const reduce = function (...args) {

package/every.js

@@ -41,15 +41,15 @@ const _every = function (collection, predicate) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type Foldable = Array|Iterable|AsyncIterable|{ reduce: function }|Object
+ * type Foldable = Array|Set|Map|Generator|AsyncGenerator|{ reduce: function }|Object
  *
- * every(collection Foldable, predicate function) -> result Promise|boolean
+ * every(fold Foldable, predicate function) -> result Promise|boolean
  *
- * every(predicate function)(collection Foldable) -> result Promise|boolean
+ * every(predicate function)(fold Foldable) -> result Promise|boolean
  * ```
  *
  * @description
- * Test a predicate concurrently across all items of a collection, returning true if all predications are truthy.
+ * Test a predicate concurrently across all items of a foldable, returning true if all executions return true.
  *
  * ```javascript [playground]
  * const isOdd = number => number % 2 == 1
@@ -63,7 +63,16 @@ const _every = function (collection, predicate) {
  * ) // true
  * ```
  *
- * The collection can be any iterable, async iterable, or object values iterable collection. Below is an example of `every` accepting an async generator as the collection.
+ * The following data types are considered to be foldables:
+ *  * `array`
+ *  * `set`
+ *  * `map`
+ *  * `generator`
+ *  * `async generator`
+ *  * `object with .reduce method`
+ *  * `object`
+ *
+ * `every` works for async generators.
  *
  * ```javascript [playground]
  * const asyncNumbers = async function* () {
@@ -88,6 +97,11 @@ const _every = function (collection, predicate) {
  * every(Promise.resolve([1, 2, 3, 4, 5]), n => n < 6).then(console.log) // true
  * ```
  *
+ * See also:
+ *  * [map](/docs/map)
+ *  * [some](/docs/some)
+ *  * [and](/docs/and)
+ *
  * @execution concurrent
  *
  * @muxing

package/filter.js

@@ -90,38 +90,74 @@ const _filter = function (value, predicate) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type Filterable = Array|Object|Set|Generator|AsyncGenerator
+ * type Filterable = Array|Set|Map|Generator|AsyncGenerator|{ filter: function }|Object
  *
  * type Predicate = (
  *   value any,
- *   indexOrKey number|string,
- *   collection Filterable,
+ *   indexOrKey number|string|any,
+ *   filt Filterable,
  * )=>boolean
  *
- * filter(f Map|Filterable, predicate Predicate) -> result Promise|Map|Filterable
- * filter(predicate Predicate)(f Map|Filterable) -> result Promise|Map|Filterable
+ * filter(filt Filterable, predicate Predicate) -> result Promise|Filterable
+ * filter(predicate Predicate)(filt Filterable) -> result Promise|Filterable
  * ```
  *
  * @description
- * Filter out items from a filterable. Returns a filterable of the same type.
+ * Filters out items from a filterable. Returns a filterable of the same type. The order of the items in the filterable is preserved.
  *
- * The following data types are considered filterable:
+ * The following data types are considered to be filterables:
  *  * `array`
- *  * `object`
  *  * `set`
+ *  * `map`
  *  * `generator`
  *  * `async generator`
+ *  * `object with .filter method`
+ *  * `object`
  *
  * The filtering operation is defined by a given predicate function. The predicate function dictates whether a given item from the filterable should be included in the returned filterable.
  *
  * ```javascript
  * const predicate = function (item) {
- *   // condition is a boolean value involving item
+ *   // condition is the boolean result of the predicate test on item
  *   return condition
  * }
  * ```
  *
- * `filter` applies a provided predicate function to each item of a filterable, returning a filterable of the same type containing only the items with truthy conditions by the predicate. The order of the items is preserved.
+ * The predicate function signature changes depending on the provided filterable.
+ *
+ * If the filterable is an array:
+ * ```coffeescript [specscript]
+ * predicate(item any, index number, filt Array) -> condition Promise|boolean|any
+ * ```
+ *
+ * If the filterable is a set:
+ * ```coffeescript [specscript]
+ * predicate(item any, item any, filt Set) -> condition Promise|boolean|any
+ * ```
+ *
+ * If the filterable is a map:
+ * ```coffeescript [specscript]
+ * predicate(item any, key any, filt Map) -> condition Promise|boolean|any
+ * ```
+ *
+ * If the filterable is a generator:
+ * ```coffeescript [specscript]
+ * predicate(item any) -> condition Promise|boolean|any
+ * ```
+ *
+ * If the filterable is an async generator:
+ * ```coffeescript [specscript]
+ * predicate(item any) -> condition Promise|boolean|any
+ * ```
+ *
+ * If the filterable is an object with a `.filter` method, the predicate function signature is defined externally.
+ *
+ * If the filterable is a plain object:
+ * ```coffeescript [specscript]
+ * predicate(item any, key string, filt Object) -> condition Promise|boolean|any
+ * ```
+ *
+ * `filter` works for arrays.
  *
  * ```javascript [playground]
  * const isOdd = number => number % 2 == 1
@@ -132,7 +168,7 @@ const _filter = function (value, predicate) {
  * console.log(result) // [1, 3, 5]
  * ```
  *
- * The predicate may be asynchronous, in which case the returned promise is concurrently resolved for its boolean condition before deciding whether to include the corresponding item in the result.
+ * If the predicate is asynchronous, the returned promise is concurrently resolved for its boolean condition before continuing with the filtering operation.
  *
  * ```javascript [playground]
  * const asyncIsOdd = async number => number % 2 == 1
@@ -143,7 +179,7 @@ const _filter = function (value, predicate) {
  * promise.then(console.log) // [1, 3, 5]
  * ```
  *
- * For objects, `filter` applies the predicate function to just the values.
+ * `filter` applies the predicate function to just the values of an object.
  *
  * ```javascript [playground]
  * const isOdd = number => number % 2 == 1
@@ -154,7 +190,7 @@ const _filter = function (value, predicate) {
  * console.log(result) // { a: 1, c: 3, e: 5 }
  * ```
  *
- * For maps, `filter` applies the predicate to the values of the entries. The order of the entries is preserved.
+ * `filter` applies the predicate to the values of the entries of a map.
  *
  * ```javascript [playground]
  * const isOdd = number => number % 2 == 1
@@ -165,7 +201,7 @@ const _filter = function (value, predicate) {
  * console.log(result) // Map(3) { 'a' => 1, 'c' => 3, 'e' => 5 }
  * ```
  *
- * For generators, `filter` returns a lazily filtered generator. All values that are normally yielded by the generator that test falsy by the predicate are skipped.
+ * For generators, `filter` returns a lazily filtered generator. All values that are normally yielded by the generator that test false by the predicate are excluded from the returned generator.
  *
  * ```javascript [playground]
  * const isOdd = number => number % 2 == 1
@@ -192,7 +228,7 @@ const _filter = function (value, predicate) {
  * }
  * ```
  *
- * For async generators, `filter` returns a lazily filtered async generator. All values that are normally yielded by the async generator that test falsy by the predicate are skipped.
+ * For async generators, `filter` returns a lazily filtered async generator. All values that are normally yielded by the async generator that test falsy by the predicate are excluded from the returned async generator.
  *
  * ```javascript [playground]
  * const asyncIsOdd = async number => number % 2 == 1
@@ -229,6 +265,14 @@ const _filter = function (value, predicate) {
  * // [1, 3, 5]
  * ```
  *
+ * See also:
+ *  * [forEach](/docs/forEach)
+ *  * [map](/docs/map)
+ *  * [reduce](/docs/reduce)
+ *  * [transform](/docs/transform)
+ *  * [flatMap](/docs/flatMap)
+ *  * [some](/docs/some)
+ *
  * @execution concurrent
  *
  * @transducing