rubico 2.6.6 → 2.7.1

package/Transducer.d.ts

@@ -202,7 +202,7 @@ export function passthrough(reducer: any): any;
  *
  * ```javascript [playground]
  * const db = new Map()
- * db.set('a', { id: 'a', name: 'George' })
+ * db.set('a', { id: 'a', name: 'John' })
  * db.set('b', { id: 'b', name: 'Jane' })
  * db.set('c', { id: 'c', name: 'Jill' })
  * db.set('e', { id: 'e', name: 'Jim' })

package/Transducer.js

@@ -24,8 +24,6 @@ const Transducer = {}
  * type Reducer = (
  *   accumulator any,
  *   value any,
- *   indexOrKey? number|string,
- *   collection? Foldable,
  * )=>(nextAccumulator Promise|any)
  *
  * type Transducer = Reducer=>Reducer
@@ -63,7 +61,16 @@ const Transducer = {}
  * ) // [1, 4, 9, 16, 25]
  * ```
  *
- * Read more on transducers [here](/blog/transducers-crash-course-rubico-v2).
+ * Read more on [transducers](/blog/transducers-crash-course-rubico-v2).
+ *
+ * See also:
+ *  * [thunkify](/docs/thunkify)
+ *  * [Transducer.filter](/docs/Transducer.filter)
+ *  * [Transducer.flatMap](/docs/Transducer.flatMap)
+ *  * [Transducer.forEach](/docs/Transducer.forEach)
+ *  * [Transducer.passthrough](/docs/Transducer.passthrough)
+ *  * [Transducer.tryCatch](/docs/Transducer.tryCatch)
+ *
  */
 Transducer.map = function transducerMap(mapper) {
   return curry2(reducerMap, __, mapper)
@@ -77,8 +84,6 @@ Transducer.map = function transducerMap(mapper) {
  * type Reducer = (
  *   accumulator any,
  *   value any,
- *   indexOrKey? number|string,
- *   collection? Foldable,
  * )=>(nextAccumulator Promise|any)
  *
  * type Transducer = Reducer=>Reducer
@@ -100,6 +105,17 @@ Transducer.map = function transducerMap(mapper) {
  *   [1, 2, 3, 4, 5].reduce(concatOddNumbers, []),
  * ) // [1, 3, 5]
  * ```
+ *
+ * Read more on [transducers](/blog/transducers-crash-course-rubico-v2).
+ *
+ * See also:
+ *  * [thunkify](/docs/thunkify)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *  * [Transducer.flatMap](/docs/Transducer.flatMap)
+ *  * [Transducer.forEach](/docs/Transducer.forEach)
+ *  * [Transducer.passthrough](/docs/Transducer.passthrough)
+ *  * [Transducer.tryCatch](/docs/Transducer.tryCatch)
+ *
  */
 Transducer.filter = function transducerFilter(predicate) {
   return curry2(reducerFilter, __, predicate)
@@ -113,8 +129,6 @@ Transducer.filter = function transducerFilter(predicate) {
  * type Reducer = (
  *   accumulator any,
  *   value any,
- *   indexOrKey? number|string,
- *   collection? Foldable,
  * )=>(nextAccumulator Promise|any)
  *
  * type Transducer = Reducer=>Reducer
@@ -135,7 +149,16 @@ Transducer.filter = function transducerFilter(predicate) {
  * ) // [1, 1, 1, 2, 4, 8, 3, 9, 27, 4, 16, 64, 5, 25, 125]
  * ```
  *
- * Read more on transducers [here](/blog/transducers-crash-course-rubico-v2).
+ * Read more on [transducers](/blog/transducers-crash-course-rubico-v2).
+ *
+ * See also:
+ *  * [thunkify](/docs/thunkify)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *  * [Transducer.filter](/docs/Transducer.filter)
+ *  * [Transducer.forEach](/docs/Transducer.forEach)
+ *  * [Transducer.passthrough](/docs/Transducer.passthrough)
+ *  * [Transducer.tryCatch](/docs/Transducer.tryCatch)
+ *
  */
 Transducer.flatMap = function transducerFlatMap(flatMapper) {
   return curry2(reducerFlatMap, __, flatMapper)
@@ -149,8 +172,6 @@ Transducer.flatMap = function transducerFlatMap(flatMapper) {
  * type Reducer = (
  *   accumulator any,
  *   value any,
- *   indexOrKey? number|string,
- *   collection? Foldable,
  * )=>(nextAccumulator Promise|any)
  *
  * type Transducer = Reducer=>Reducer
@@ -168,6 +189,17 @@ Transducer.flatMap = function transducerFlatMap(flatMapper) {
  *   Transducer.forEach(console.log), // 1 4 9 16 25
  * ]), null)
  * ```
+ *
+ * Read more on [transducers](/blog/transducers-crash-course-rubico-v2).
+ *
+ * See also:
+ *  * [thunkify](/docs/thunkify)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *  * [Transducer.filter](/docs/Transducer.filter)
+ *  * [Transducer.flatMap](/docs/Transducer.flatMap)
+ *  * [Transducer.passthrough](/docs/Transducer.passthrough)
+ *  * [Transducer.tryCatch](/docs/Transducer.tryCatch)
+ *
  */
 Transducer.forEach = function transducerForEach(func) {
   return curry2(reducerForEach, __, func)
@@ -181,8 +213,6 @@ Transducer.forEach = function transducerForEach(func) {
  * type Reducer = (
  *   accumulator any,
  *   value any,
- *   indexOrKey? number|string,
- *   collection? Foldable,
  * )=>(nextAccumulator Promise|any)
  *
  * type Transducer = Reducer=>Reducer
@@ -205,6 +235,17 @@ Transducer.forEach = function transducerForEach(func) {
  * transform(createAsyncNumbers(), Transducer.passthrough, [])
  *   .then(console.log) // [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
  * ```
+ *
+ * Read more on [transducers](/blog/transducers-crash-course-rubico-v2).
+ *
+ * See also:
+ *  * [thunkify](/docs/thunkify)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *  * [Transducer.filter](/docs/Transducer.filter)
+ *  * [Transducer.flatMap](/docs/Transducer.flatMap)
+ *  * [Transducer.forEach](/docs/Transducer.forEach)
+ *  * [Transducer.tryCatch](/docs/Transducer.tryCatch)
+ *
  */
 Transducer.passthrough = function transducerPassthrough(reducer) {
   return reducer
@@ -218,8 +259,6 @@ Transducer.passthrough = function transducerPassthrough(reducer) {
  * type Reducer = (
  *   accumulator any,
  *   item any,
- *   indexOrKey? number|string,
- *   collection? Foldable,
  * )=>(nextAccumulator Promise|any)
  *
  * type Transducer = Reducer=>Reducer
@@ -235,7 +274,7 @@ Transducer.passthrough = function transducerPassthrough(reducer) {
  *
  * ```javascript [playground]
  * const db = new Map()
- * db.set('a', { id: 'a', name: 'George' })
+ * db.set('a', { id: 'a', name: 'John' })
  * db.set('b', { id: 'b', name: 'Jane' })
  * db.set('c', { id: 'c', name: 'Jill' })
  * db.set('e', { id: 'e', name: 'Jim' })
@@ -259,7 +298,17 @@ Transducer.passthrough = function transducerPassthrough(reducer) {
  *   // original userId for which the error was thrown is provided
  * }), null)
  * ```
-
+ *
+ * Read more on [transducers](/blog/transducers-crash-course-rubico-v2).
+ *
+ * See also:
+ *  * [thunkify](/docs/thunkify)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *  * [Transducer.filter](/docs/Transducer.filter)
+ *  * [Transducer.flatMap](/docs/Transducer.flatMap)
+ *  * [Transducer.forEach](/docs/Transducer.forEach)
+ *  * [Transducer.passthrough](/docs/Transducer.passthrough)
+ *
  */
 Transducer.tryCatch = function transducerTryCatch(transducerTryer, catcher) {
   return curry3(reducerTryCatch, __, transducerTryer, catcher)

package/__.js

@@ -5,7 +5,7 @@ const __ = require('./_internal/placeholder')
  *
  * @synopsis
  * ```coffeescript [specscript]
- * __ = Symbol(placeholder)
+ * __ Symbol
  * ```
  *
  * @description
@@ -16,6 +16,15 @@ const __ = require('./_internal/placeholder')
  *   curry.arity(3, Array.of, __, 2, 3)(1),
  * ) // [1, 2, 3]
  * ```
+ *
+ * See also:
+ *  * [eq](/docs/eq)
+ *  * [thunkify](/docs/thunkify)
+ *  * [always](/docs/always)
+ *  * [curry](/docs/curry)
+ *  * [curry.arity](/docs/curry.arity)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *
  */
 
 module.exports = __

package/_internal/mapMapSeries.js

@@ -1,3 +1,4 @@
+const __ = require('./placeholder')
 const isPromise = require('./isPromise')
 const curry3 = require('./curry3')
 const thunkify3 = require('./thunkify3')

package/_internal/objectMapSeries.js

@@ -1,3 +1,4 @@
+const __ = require('./placeholder')
 const isPromise = require('./isPromise')
 const curry3 = require('./curry3')
 const thunkify4 = require('./thunkify4')

package/_internal/setMapSeries.js

@@ -1,3 +1,4 @@
+const __ = require('./placeholder')
 const isPromise = require('./isPromise')
 const curry2 = require('./curry2')
 const thunkify3 = require('./thunkify3')

package/all.d.ts

@@ -46,7 +46,7 @@ export = all;
  * const identity = value => value
  *
  * const userbase = new Map()
- * userbase.set('1', { _id: 1, name: 'George' })
+ * userbase.set('1', { _id: 1, name: 'John' })
  *
  * const getUserByID = async id => userbase.get(id)
  *
@@ -60,7 +60,7 @@ export = all;
  *   }),
  * ])
  *
- * getAndLogUserById('1') // Got user {"_id":1,"name":"George"} by id 1
+ * getAndLogUserById('1') // Got user {"_id":1,"name":"John"} by id 1
  * ```
  *
  * @execution concurrent

package/all.js

@@ -96,7 +96,7 @@ const _allValues = function (values) {
  * const identity = value => value
  *
  * const userbase = new Map()
- * userbase.set('1', { _id: 1, name: 'George' })
+ * userbase.set('1', { _id: 1, name: 'John' })
  *
  * const getUserByID = async id => userbase.get(id)
  *
@@ -110,7 +110,7 @@ const _allValues = function (values) {
  *   }),
  * ])
  *
- * getAndLogUserById('1') // Got user {"_id":1,"name":"George"} by id 1
+ * 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.
@@ -141,6 +141,15 @@ const _allValues = function (values) {
  * ]).then(console.log) // [2, 3, 4]
  * ```
  *
+ * See also:
+ *  * [pipe](/docs/pipe)
+ *  * [assign](/docs/assign)
+ *  * [get](/docs/get)
+ *  * [set](/docs/set)
+ *  * [pick](/docs/pick)
+ *  * [omit](/docs/omit)
+ *  * [forEach](/docs/forEach)
+ *
  * @execution concurrent
  */
 const all = function (...args) {

package/always.js

@@ -18,6 +18,14 @@ const always = require('./_internal/always')
  * console.log(always5()) // 5
  * console.log(always5()) // 5
  * ```
+ *
+ * See also:
+ *  * [eq](/docs/eq)
+ *  * [thunkify](/docs/thunkify)
+ *  * [curry](/docs/curry)
+ *  * [__](/docs/__)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *
  */
 
 module.exports = always

package/and.js

@@ -140,6 +140,12 @@ const areAllPredicatesTruthy = function (args, predicates) {
  * ]).then(console.log) // true
  * ```
  *
+ * See also:
+ *  * [some](/docs/some)
+ *  * [or](/docs/or)
+ *  * [not](/docs/not)
+ *  * [eq](/docs/eq)
+ *
  * @execution series
  *
  * @note ...args slows down here by an order of magnitude

package/assign.js

@@ -84,6 +84,15 @@ const _assign = function (object, funcs) {
  * }).then(console.log)
  * ```
  *
+ * See also:
+ *  * [pipe](/docs/pipe)
+ *  * [all](/docs/all)
+ *  * [get](/docs/get)
+ *  * [set](/docs/set)
+ *  * [pick](/docs/pick)
+ *  * [omit](/docs/omit)
+ *  * [forEach](/docs/forEach)
+ *
  * @execution concurrent
  */
 const assign = function (arg0, arg1) {

package/compose.js

@@ -10,22 +10,37 @@ const funcConcat = require('./_internal/funcConcat')
  *
  * @synopsis
  * ```coffeescript [specscript]
- * compose(funcs Array<function>)(...args) -> result Promise|any
+ * funcs Array<function>
+ * args Array<any>
+ * argsWithPromises Array<Promise|any>
  *
- * compose(...args, funcs Array<function>) -> result Promise|any
+ * compose(funcs)(...args) -> result Promise|any
+ *
+ * compose(...argsWithPromises, funcs) -> result Promise|any
+ *
+ * compose(...funcs)(...args) -> result Promise|any
  * ```
  *
  * @description
- * Creates a function composition from an array of functions, where each function passes its return value as a single argument to the previous function until all functions have executed. The last function is called with the arguments to the composition, while the result of a function composition is the return value of its first function. If any function of the composition is asynchronous, the result of the execution is a Promise. `compose` is effectively `pipe` in reverse.
+ * 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. If any function in the composition is asynchronous, the result of the composition execution is a Promise.
+ *
+ * ```javascript [playground]
+ * const f = x => x * 2
+ * const g = x => x + 3
+ *
+ * const result = compose(5, [f, g])
+ * console.log(result) // 16
+ * ```
+ *
+ * `compose` supports a mathematical API.
  *
  * ```javascript [playground]
- * const f = number => number * 2
+ * const f = x => x * 2
+ * const g = x => x + 1
  *
- * const g = number => number + 3
+ * const composition = compose(f, g)
  *
- * console.log(
- *   compose(5, [f, g]),
- * ) // 16
+ * console.log(composition(1)) // 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.
@@ -35,8 +50,18 @@ const funcConcat = require('./_internal/funcConcat')
  *   console.log, // [1, 2, 3]
  * ])
  * ```
+ *
+ * See also:
+ *  * [pipe](/docs/pipe)
+ *  * [tap](/docs/tap)
+ *  * [switchCase](/docs/switchCase)
+ *  * [tryCatch](/docs/tryCatch)
  */
 const compose = function (...args) {
+  if (typeof args[0] == 'function') {
+    return args.reduceRight(funcConcat)
+  }
+
   const funcs = args.pop()
   const composition = funcs.reduceRight(funcConcat)
 

package/curry.js

@@ -35,6 +35,15 @@ const curryArity = require('./_internal/curryArity')
  * console.log(curry(add, __, __, 'c')('a', 'b')) // abc
  * console.log(curry(add, __, __, 'c')(__, 'b')('a')) // abc
  * ```
+ *
+ * See also:
+ *  * [eq](/docs/eq)
+ *  * [thunkify](/docs/thunkify)
+ *  * [always](/docs/always)
+ *  * [curry.arity](/docs/curry.arity)
+ *  * [__](/docs/__)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *
  */
 const curry = (func, ...args) => curryArity(func.length, func, args)
 
@@ -66,6 +75,15 @@ const curry = (func, ...args) => curryArity(func.length, func, args)
  *
  * console.log(curry.arity(2, add, 1, 2)) // 3
  * ```
+ *
+ * See also:
+ *  * [eq](/docs/eq)
+ *  * [thunkify](/docs/thunkify)
+ *  * [always](/docs/always)
+ *  * [curry](/docs/curry)
+ *  * [__](/docs/__)
+ *  * [Transducer.map](/docs/Transducer.map)
+ *
  */
 curry.arity = function curryArity_(arity, func, ...args) {
   return curryArity(arity, func, args)

package/dist/Transducer.es.js

@@ -1,5 +1,5 @@
 /**
- * rubico v2.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * 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.6.6
+ * rubico v2.7.1
  * https://github.com/a-synchronous/rubico
  * (c) 2019-2025 Richard Tong
  * rubico may be freely distributed under the MIT license.