rubico 2.12.1 → 2.13.0

package/map.js

@@ -96,14 +96,14 @@ const _map = function (value, f) {
  * ```coffeescript [specscript]
  * type Functor = Array|Set|Map|Generator|AsyncGenerator|{ map: function }|Object
  *
- * type SyncOrAsyncMapper = (
+ * type Mapper = (
  *   item any,
  *   indexOrKey number|string|any,
  *   functor Functor
  * )=>(mappedItem Promise|any)
  *
- * map(functor Promise|Functor, mapper SyncOrAsyncMapper) -> mappedFunctor Promise|Functor
- * map(mapper SyncOrAsyncMapper)(functor Functor) -> mappedFunctor Promise|Functor
+ * map(functor Promise|Functor, mapper Mapper) -> mappedFunctor Promise|Functor
+ * map(mapper Mapper)(functor Functor) -> mappedFunctor Promise|Functor
  * ```
  *
  * @description
@@ -369,13 +369,13 @@ map.entries = function mapEntries(arg0, arg1) {
  * ```coffeescript [specscript]
  * type Functor = Array|Object|Set|Map
  *
- * type SyncOrAsyncMapper = (
+ * type Mapper = (
  *   value any,
  *   indexOrKey number|string|any,
  *   f Functor
  * )=>(mappedItem Promise|any)
  *
- * _mapSeries(f Functor, f SyncOrAsyncMapper) -> result Promise|Functor
+ * _mapSeries(f Functor, f Mapper) -> result Promise|Functor
  * ```
  */
 const _mapSeries = function (functor, f) {
@@ -417,7 +417,7 @@ const _mapSeries = function (functor, f) {
  * ```coffeescript [specscript]
  * type Functor = Array|Set|Map|Generator|AsyncGenerator|{ map: function }|Object
  *
- * type SyncOrAsyncMapper = (
+ * type Mapper = (
  *   value any,
  *   indexOrKey number|string|any,
  *   functor Functor,
@@ -425,11 +425,11 @@ const _mapSeries = function (functor, f) {
  *
  * map.series(
  *   functor Promise|Functor,
- *   mapper SyncOrAsyncMapper
+ *   mapper Mapper
  * ) -> mappedFunctor Promise|Functor
  *
  * map.series(
- *   mapper SyncOrAsyncMapper
+ *   mapper Mapper
  * )(functor Functor) -> mappedFunctor Promise|Functor
  * ```
  *
@@ -521,7 +521,7 @@ const _mapPool = function (f, concurrency, mapper) {
  * ```coffeescript [specscript]
  * type MapPoolFunctor = Array|Object|Set|Map
  *
- * type SyncOrAsyncMapper = (
+ * type Mapper = (
  *   item any,
  *   indexOrKey number|string|any,
  *   functor Functor
@@ -530,12 +530,12 @@ const _mapPool = function (f, concurrency, mapper) {
  * map.pool(
  *   functor MapPoolFunctor,
  *   concurrency number,
- *   mapper SyncOrAsyncMapper
+ *   mapper Mapper
  * ) -> result Promise|Array
  *
  * map.pool(
  *   concurrency number,
- *   mapper SyncOrAsyncMapper
+ *   mapper Mapper
  * )(functor MapPoolFunctor) -> result Promise|Array
  * ```
  *

package/not.js

@@ -19,11 +19,11 @@ const _not = function (args, predicate) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type SyncOrAsyncPredicate = (...arguments)=>Promise|boolean
+ * type Predicate = (...arguments)=>Promise|boolean
  *
  * not(value Promise|boolean|any) -> negatedResult Promise|boolean
- * not(...arguments, predicate SyncOrAsyncPredicate) -> negatedResult Promise|boolean
- * not(predicate SyncOrAsyncPredicate)(...arguments) -> negatedResult Promise|boolean
+ * not(...arguments, predicate Predicate) -> negatedResult Promise|boolean
+ * not(predicate Predicate)(...arguments) -> negatedResult Promise|boolean
  * ```
  *
  * @description

package/or.js

@@ -97,11 +97,11 @@ const areAnyPredicatesTruthy = function (args, predicates) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type SyncOrAsyncPredicate = (...arguments)=>Promise|boolean|any
+ * type Predicate = (...arguments)=>Promise|boolean|any
  *
  * or(values Array<boolean|any>) -> testResult boolean
- * or(...arguments, predicatesOrValues Array<SyncOrAsyncPredicate|boolean|any>) -> testResult Promise|boolean
- * or(predicatesOrValues Array<SyncOrAsyncPredicate|boolean|any>)(...arguments) -> testResult Promise|boolean
+ * or(...arguments, predicatesOrValues Array<Predicate|boolean|any>) -> testResult Promise|boolean
+ * or(predicatesOrValues Array<Predicate|boolean|any>)(...arguments) -> testResult Promise|boolean
  * ```
  *
  * @description

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rubico",
-  "version": "2.12.1",
+  "version": "2.13.0",
   "description": "[a]synchronous functional programming",
   "author": "Richard Tong",
   "license": "CFOSS",

package/pipe.js

@@ -10,14 +10,14 @@ const __ = require('./_internal/placeholder')
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type SyncOrAsyncFunction = (...arguments)=>Promise|any
- * type UnarySyncOrAsyncFunction = any=>Promise|any
+ * type Function = (...arguments)=>Promise|any
+ * type UnaryFunction = any=>Promise|any
  *
- * funcs [SyncOrAsyncFunction, ...Array<UnarySyncOrAsyncFunction>]
+ * funcs [Function, ...Array<UnaryFunction>]
  *
- * pipe(funcs)(...arguments) -> Promise|any
- * pipe(...arguments, funcs) -> Promise|any
- * pipe(...funcs)(...arguments) -> Promise|any
+ * pipe(funcs)(...arguments) -> result Promise|any
+ * pipe(...arguments, funcs) -> result Promise|any
+ * pipe(...funcs)(...arguments) -> result Promise|any
  * ```
  *
  * @description

package/reduce.js

@@ -23,22 +23,22 @@ const _reduce = function (collection, reducer, initial) {
  * ```coffeescript [specscript]
  * type Foldable = Array|Set|Map|Generator|AsyncGenerator|{ reduce: function }|Object
  *
- * type SyncOrAsyncReducer = (
+ * type Reducer = (
  *   accumulator any,
  *   item any,
  *   indexOrKey number|string|any,
  *   foldable Foldable
  * )=>(nextAccumulator Promise|any)
  *
- * type UnarySyncOrAsyncResolver = any=>Promise|any
+ * type Resolver = any=>Promise|any
  *
- * reduce(foldable Promise|Foldable, reducer SyncOrAsyncReducer) -> accumulator Promise|any
- * reduce(foldable Promise|Foldable, reducer SyncOrAsyncReducer, initialValue Promise|any) -> accumulator Promise|any
- * reduce(foldable Promise|Foldable, reducer SyncOrAsyncReducer, initialResolver UnarySyncOrAsyncResolver) -> accumulator Promise|any
+ * reduce(foldable Promise|Foldable, reducer Reducer) -> accumulator Promise|any
+ * reduce(foldable Promise|Foldable, reducer Reducer, initialValue Promise|any) -> accumulator Promise|any
+ * reduce(foldable Promise|Foldable, reducer Reducer, initialResolver Resolver) -> accumulator Promise|any
  *
- * reduce(reducer SyncOrAsyncReducer)(foldable Foldable) -> accumulator Promise|any
- * reduce(reducer SyncOrAsyncReducer, initialValue Promise|any)(foldable Foldable) -> accumulator Promise|any
- * reduce(reducer SyncOrAsyncReducer, initialResolver UnarySyncOrAsyncResolver)(foldable Foldable) -> accumulator Promise|any
+ * reduce(reducer Reducer)(foldable Foldable) -> accumulator Promise|any
+ * reduce(reducer Reducer, initialValue Promise|any)(foldable Foldable) -> accumulator Promise|any
+ * reduce(reducer Reducer, initialResolver Resolver)(foldable Foldable) -> accumulator Promise|any
  * ```
  *
  * @description

package/some.js

@@ -41,9 +41,9 @@ const _some = function (collection, predicate) {
  * @synopsis
  * ```coffeescript [specscript]
  * type Foldable = Array|Set|Map|Generator|AsyncGenerator|{ reduce: function }|Object
- * type UnarySyncOrAsyncPredicate = any=>Promise|boolean
+ * type Predicate = any=>Promise|boolean
  *
- * predicate UnarySyncOrAsyncPredicate
+ * predicate Predicate
  *
  * some(foldable Promise|Foldable, predicate) -> testResult Promise|boolean
  * some(predicate)(foldable Foldable) -> testResult Promise|boolean

package/switchCase.js

@@ -12,15 +12,15 @@ const curryArgs3 = require('./_internal/curryArgs3')
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type SyncOrAsyncPredicate = (...arguments)=>Promise|boolean|any
- * type SyncOrAsyncFunction = (...arguments)=>Promise|any
+ * type Predicate = (...arguments)=>Promise|boolean|any
+ * type Function = (...arguments)=>Promise|any
  *
  * conditionalValues Array<Promise|boolean|any>
- * conditionalFunctionsOrValues Array<SyncOrAsyncPredicate|SyncOrAsyncFunction|Promise|boolean|any>
+ * conditionalFunctionsOrValues Array<Predicate|Function|Promise|boolean|any>
  *
- * switchCase(conditionalValues) -> Promise|any
- * switchCase(...arguments, conditionalFunctionsOrValues) -> Promise|any
- * switchCase(conditionalFunctionsOrValues)(...arguments) -> Promise|any
+ * switchCase(conditionalValues) -> result Promise|any
+ * switchCase(...arguments, conditionalFunctionsOrValues) -> result Promise|any
+ * switchCase(conditionalFunctionsOrValues)(...arguments) -> result Promise|any
  * ```
  *
  * @description

package/tap.js

@@ -22,12 +22,10 @@ const _tap = function (args, f) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type SyncOrAsyncFunction = (...arguments)=>Promise|any
+ * type Function = (...arguments)=>Promise|any
  *
- * f SyncOrAsyncFunction
- *
- * tap(...arguments, f) -> Promise|arguments[0]
- * tap(f)(...arguments) -> Promise|arguments[0]
+ * tap(...arguments, f Function) -> result Promise|any
+ * tap(f Function)(...arguments) -> result Promise|any
  * ```
  *
  * @description
@@ -103,14 +101,11 @@ const _tapIf = function (predicate, f, args) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type SyncOrAsyncPredicate = (...arguments)=>Promise|boolean|any
- * type SyncOrAsyncFunction = (...arguments)=>Promise|any
- *
- * predicate SyncOrAsyncPredicate
- * f SyncOrAsyncFunction
+ * type Predicate = (...arguments)=>Promise|boolean|any
+ * type Function = (...arguments)=>Promise|any
  *
- * tap.if(...arguments, predicate, f) -> Promise|arguments[0]
- * tap.if(predicate, f)(...arguments) -> Promise|arguments[0]
+ * tap.if(...arguments, predicate Predicate, f Function) -> result Promise|any
+ * tap.if(predicate Predicate, f Function)(...arguments) -> result Promise|any
  * ```
  *
  * @description

package/transform.js

@@ -22,18 +22,18 @@ const _transform = function (collection, transducer, initialValue) {
  * @synopsis
  * ```coffeescript [specscript]
  * type Foldable = Array|Set|Map|Generator|AsyncGenerator|{ reduce: function }|Object
- * type SyncOrAsyncReducer = (accumulator any, value any)=>(nextAccumulator Promise|any)
- * type Transducer = SyncOrAsyncReducer=>SyncOrAsyncReducer
+ * type Reducer = (accumulator any, value any)=>(nextAccumulator Promise|any)
+ * type Transducer = Reducer=>Reducer
  *
  * type Semigroup = Array|String|Set|TypedArray|{ concat: function }|{ write: function }|Object
  *
- * type UnarySyncOrAsyncSemigroupResolver = any=>Promise|Semigroup
+ * type SemigroupResolver = any=>Promise|Semigroup
  *
  * transform(foldable Promise|Foldable, transducer, initialValue Promise|any) -> result Promise|Semigroup
- * transform(foldable Promise|Foldable, transducer, initialResolver UnarySyncOrAsyncSemigroupResolver) -> result Promise|Semigroup
+ * transform(foldable Promise|Foldable, transducer, initialResolver SemigroupResolver) -> result Promise|Semigroup
  *
  * transform(transducer, initialValue Promise|any)(foldable Foldable) -> result Promise|Semigroup
- * transform(transducer, initialResolver UnarySyncOrAsyncSemigroupResolver)(foldable Foldable) -> result Promise|Semigroup
+ * transform(transducer, initialResolver SemigroupResolver)(foldable Foldable) -> result Promise|Semigroup
  * ```
  *
  * @description
@@ -84,8 +84,8 @@ const _transform = function (collection, transducer, initialValue) {
  * The transducer defines the transformation done by `transform`. In a transformation, each item of the foldable is processed by the transducer in series.
  *
  * ```coffeescript [specscript]
- * type SyncOrAsyncReducer = (accumulator any, value any)=>(nextAccumulator Promise|any)
- * type Transducer = SyncOrAsyncReducer=>SyncOrAsyncReducer
+ * type Reducer = (accumulator any, value any)=>(nextAccumulator Promise|any)
+ * type Transducer = Reducer=>Reducer
  * ```
  *
  * The following data types are considered to be semigroups:

package/tryCatch.js

@@ -22,14 +22,11 @@ const _tryCatch = function (tryer, catcher, args) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type SyncOrAsyncFunction = (...arguments)=>Promise|any
- * type SyncOrAsyncCatcher = (error Error|any, ...arguments)=>Promise|any
+ * type Function = (...arguments)=>Promise|any
+ * type Catcher = (error Error|any, ...arguments)=>Promise|any
  *
- * tryer SyncOrAsyncFunction
- * catcher SyncOrAsyncCatcher
- *
- * tryCatch(tryer, catcher)(...arguments) -> Promise|any
- * tryCatch(...arguments, tryer, catcher) -> Promise|any
+ * tryCatch(tryer Function, catcher Catcher)(...arguments) -> result Promise|any
+ * tryCatch(...arguments, tryer Function, catcher Catcher) -> result Promise|any
  * ```
  *
  * @description

package/_internal/add.js

@@ -1,12 +0,0 @@
-/**
- * @name add
- *
- * @synopsis
- * add (a any, b any) -> a + b
- *
- * @description
- * `+` two things
- */
-const add = (a, b) => a + b
-
-module.exports = add