rubico 2.2.2 → 2.3.0

package/_internal/arrayForEach.d.ts

@@ -0,0 +1,19 @@
+export = arrayForEach;
+/**
+ * @name arrayForEach
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * var T any,
+ *   array Array<T>,
+ *   callback T=>()
+ *
+ * arrayForEach(array, callback) -> ()
+ * ```
+ *
+ * @description
+ * Call a callback for each item of an iterator. Return a promise if any executions are asynchronous.
+ *
+ * Note: iterator is consumed
+ */
+declare function arrayForEach(array: any, callback: any): any;

package/_internal/arrayJoin.d.ts

@@ -0,0 +1,13 @@
+export = arrayJoin;
+/**
+ * @name arrayJoin
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * arrayJoin(array Array, delimiter string) -> string
+ * ```
+ *
+ * @description
+ * Call `.join` on an array.
+ */
+declare function arrayJoin(array: any, delimiter: any): any;

package/_internal/arrayMap.d.ts

@@ -0,0 +1,16 @@
+export = arrayMap;
+/**
+ * @name arrayMap
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * arrayMap(
+ *   array Array,
+ *   mapper (item any, index number, array Array)=>Promise|any,
+ * ) -> Promise|Array
+ * ```
+ *
+ * @description
+ * Apply a mapper to each item of an array, returning an array. Mapper may be asynchronous.
+ */
+declare function arrayMap(array: any, mapper: any): any;

package/_internal/arrayMapPool.d.ts

@@ -0,0 +1,19 @@
+export = arrayMapPool;
+/**
+ * @name
+ * arrayMapPool
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * arrayMapPool<
+ *   T any,
+ *   array Array<T>
+ *   mapper T=>Promise|any,
+ *   concurrentLimit number,
+ * >(array, mapper, concurrentLimit) -> Promise|Array
+ * ```
+ *
+ * @description
+ * Apply a mapper with limited concurrency to each item of an array, returning an array of results.
+ */
+declare function arrayMapPool(array: any, mapper: any, concurrentLimit: any): any[] | Promise<any>;

package/_internal/arrayMapSeries.d.ts

@@ -0,0 +1,17 @@
+export = arrayMapSeries;
+/**
+ * @name arrayMapSeries
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * arrayMapSeries<
+ *   T any,
+ *   array Array<T>,
+ *   mapper T=>Promise|any,
+ * >(array, mapper) -> mappedInSeries Promise|Array
+ * ```
+ *
+ * @description
+ * Apply a mapper in series to each item of an array, returning an array of results.
+ */
+declare function arrayMapSeries(array: any, mapper: any): any;

package/_internal/arrayPush.d.ts

@@ -0,0 +1,11 @@
+export = arrayPush;
+/**
+ * @name arrayPush
+ *
+ * @synopsis
+ * arrayPush(
+ *   array Array,
+ *   value any
+ * ) -> array
+ */
+declare function arrayPush(array: any, value: any): any;

package/_internal/arrayReduce.d.ts

@@ -0,0 +1,14 @@
+export = arrayReduce;
+/**
+ * @name arrayReduce
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * arrayReduce<T>(
+ *   array Array<T>,
+ *   reducer (any, T)=>Promise|any,
+ *   result any,
+ * ) -> Promise|result
+ * ```
+ */
+declare function arrayReduce(array: any, reducer: any, result: any): any;

package/_internal/arraySome.d.ts

@@ -0,0 +1,13 @@
+export = arraySome;
+/**
+ * @name arraySome
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * arraySome(
+ *   array Array,
+ *   predicate any=>Promise|boolean,
+ * ) -> boolean
+ * ```
+ */
+declare function arraySome(array: any, predicate: any): boolean | Promise<boolean>;

package/_internal/asyncIteratorEvery.d.ts

@@ -0,0 +1,16 @@
+export = asyncIteratorEvery;
+/**
+ * @name asyncIteratorEvery
+ *
+ * @synopsis
+ * var T any,
+ *   asyncIterator AsyncIterator<T>,
+ *   predicate T=>Promise|boolean,
+ *   promisesInFlight Set<Promise<[T, Promise]>>,
+ *   maxConcurrency number
+ *
+ * asyncIteratorEvery(
+ *   asyncIterator, predicate, promisesInFlight, maxConcurrency,
+ * ) -> Promise<boolean>
+ */
+declare function asyncIteratorEvery(asyncIterator: any, predicate: any, promisesInFlight: any, maxConcurrency?: number): Promise<boolean>;

package/_internal/asyncIteratorForEach.d.ts

@@ -0,0 +1,17 @@
+export = asyncIteratorForEach;
+/**
+ * @name asyncIteratorForEach
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * var T any,
+ *   asyncIterator AsyncIterator<T>,
+ *   callback T=>()
+ *
+ * asyncIteratorForEach(asyncIterator, callback) -> Promise<>
+ * ```
+ *
+ * @description
+ * Execute a callback function for each item of an async iterator
+ */
+declare function asyncIteratorForEach(asyncIterator: any, callback: any): Promise<any>;

package/_internal/asyncIteratorReduce.d.ts

@@ -0,0 +1,14 @@
+export = asyncIteratorReduce;
+/**
+ * @name asyncIteratorReduce
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * asyncIteratorReduce(
+ *   asyncIterator AsyncIterator<T>,
+ *   reducer (any, T)=>Promise|any,
+ *   result any,
+ * ) -> result any
+ * ```
+ */
+declare function asyncIteratorReduce(asyncIterator: any, reducer: any, result: any): Promise<any>;

package/_internal/asyncIteratorSome.d.ts

@@ -0,0 +1,16 @@
+export = asyncIteratorSome;
+/**
+ * @name asyncIteratorSome
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * asyncIteratorSome(
+ *   iterator Iterator|AsyncIterator,
+ *   predicate any=>Promise|boolean,
+ *   index number,
+ *   promisesInFlight Set<Promise>,
+ *   maxConcurrency number=20,
+ * ) -> boolean
+ * ```
+ */
+declare function asyncIteratorSome(iterator: any, predicate: any, promisesInFlight: any, maxConcurrency?: number): Promise<boolean>;

package/_internal/binaryExtend.d.ts

@@ -0,0 +1,16 @@
+export = binaryExtend;
+/**
+ * @name binaryExtend
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * binaryExtend(
+ *   typedArray TypedArray,
+ *   array Array|TypedArray|any,
+ * ) -> concatenatedTypedArray
+ * ```
+ *
+ * @description
+ * Types branching for _binaryExtend
+ */
+declare function binaryExtend(typedArray: any, array: any): any;

package/_internal/bufferAlloc.d.ts

@@ -0,0 +1,8 @@
+export = bufferAlloc;
+/**
+ * @name bufferAlloc
+ *
+ * @synopsis
+ * Dereferenced `Buffer.alloc` or noop
+ */
+declare const bufferAlloc: any;

package/_internal/callConcat.d.ts

@@ -0,0 +1,8 @@
+export = callConcat;
+/**
+ * @name callConcat
+ *
+ * @synopsis
+ * callConcat(object Object, values any) -> object.concat(values)
+ */
+declare function callConcat(object: any, values: any): any;

package/_internal/callPropBinary.d.ts

@@ -0,0 +1,18 @@
+export = callPropBinary;
+/**
+ * @name callPropBinary
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * callPropBinary(
+ *   value object,
+ *   property string,
+ *   arg0 any,
+ *   arg1 any,
+ * ) -> value[property](arg0, arg1)
+ * ```
+ *
+ * @description
+ * Call a property function on a value with two arguments.
+ */
+declare function callPropBinary(value: any, property: any, arg0: any, arg1: any): any;

package/_internal/callPropUnary.d.ts

@@ -0,0 +1,17 @@
+export = callPropUnary;
+/**
+ * @name callPropUnary
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * callPropUnary(
+ *   value object,
+ *   property string,
+ *   arg0 any,
+ * ) -> value[property](arg0)
+ * ```
+ *
+ * @description
+ * Call a property function on a value with a single argument.
+ */
+declare function callPropUnary(value: any, property: any, arg0: any): any;

package/_internal/catcherApply.d.ts

@@ -0,0 +1,17 @@
+export = catcherApply;
+/**
+ * @name catcherApply
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * catcherApply<
+ *   args ...any,
+ *   err Error|any,
+ *   catcher (err, ...args)=>any,
+ * >(catcher, err, args) -> catcher(err, ...args)
+ * ```
+ *
+ * @description
+ * Apply an error and arguments to a catcher.
+ */
+declare function catcherApply(catcher: any, err: any, args: any): any;

package/_internal/copyDeep.d.ts

@@ -0,0 +1,13 @@
+export = copyDeep;
+/**
+ * @name copyDeep
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * copyDeep(value Array|Object) -> deepCopy Array|Object
+ * ```
+ *
+ * @catchphrase
+ * Deep copy objects or arrays.
+ */
+declare function copyDeep(value: any): any;

package/_internal/curry2.d.ts

@@ -0,0 +1,21 @@
+export = curry2;
+/**
+ * @name curry2
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * __ = Symbol('placeholder')
+ *
+ * curry2(
+ *   baseFunc function,
+ *   arg0 __|any,
+ *   arg1 __|any,
+ * ) -> function
+ * ```
+ *
+ * @description
+ * Curry a binary function.
+ *
+ * Note: exactly one argument must be the placeholder
+ */
+declare function curry2(baseFunc: any, arg0: any, arg1: any): (arg0: any) => any;

package/_internal/curry3.d.ts

@@ -0,0 +1,22 @@
+export = curry3;
+/**
+ * @name curry3
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * __ = Symbol('placeholder')
+ *
+ * curry3(
+ *   baseFunc function,
+ *   arg0 __|any,
+ *   arg1 __|any,
+ *   arg2 __|any
+ * ) -> function
+ * ```
+ *
+ * @description
+ * Curry a 3-ary function.
+ *
+ * Note: exactly one argument must be the placeholder
+ */
+declare function curry3(baseFunc: any, arg0: any, arg1: any, arg2: any): (arg0: any) => any;

package/_internal/curry4.d.ts

@@ -0,0 +1,23 @@
+export = curry4;
+/**
+ * @name curry4
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * __ = Symbol('placeholder')
+ *
+ * curry4(
+ *   baseFunc function,
+ *   arg0 __|any,
+ *   arg1 __|any,
+ *   arg2 __|any,
+ *   arg3 __|any,
+ * ) -> function
+ * ```
+ *
+ * @description
+ * Curry a 4-ary function.
+ *
+ * Note: exactly one argument must be the placeholder
+ */
+declare function curry4(baseFunc: any, arg0: any, arg1: any, arg2: any, arg3: any): (arg0: any) => any;

package/_internal/curry5.d.ts

@@ -0,0 +1,24 @@
+export = curry5;
+/**
+ * @name curry5
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * __ = Symbol('placeholder')
+ *
+ * curry5(
+ *   baseFunc function,
+ *   arg0 __|any,
+ *   arg1 __|any,
+ *   arg2 __|any,
+ *   arg3 __|any,
+ *   arg4 __|any,
+ * ) -> function
+ * ```
+ *
+ * @description
+ * Curry a 5-ary function.
+ *
+ * Note: exactly one argument must be the placeholder
+ */
+declare function curry5(baseFunc: any, arg0: any, arg1: any, arg2: any, arg3: any, arg4: any): (arg0: any) => any;

package/_internal/curryArgs2.d.ts

@@ -0,0 +1,21 @@
+export = curryArgs2;
+/**
+ * @name curryArgs2
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * type __ = Symbol('placeholder')
+ *
+ * curryArgs2(
+ *   baseFunc function,
+ *   arg0 __|any,
+ *   arg1 __|any,
+ * ) -> function
+ * ```
+ *
+ * @description
+ * Curry arguments for a 2-ary function. Arguments are supplied in placeholder position as an array.
+ *
+ * Note: at least one argument must be the placeholder
+ */
+declare function curryArgs2(baseFunc: any, arg0: any, arg1: any): (...args: any[]) => any;

package/_internal/curryArgs3.d.ts

@@ -0,0 +1,22 @@
+export = curryArgs3;
+/**
+ * @name curryArgs3
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * __ = Symbol('placeholder')
+ *
+ * curryArgs3(
+ *   baseFunc function,
+ *   arg0 __|any,
+ *   arg1 __|any,
+ *   arg2 __|any
+ * ) -> function
+ * ```
+ *
+ * @description
+ * Curry arguments for a 3-ary function. Arguments are supplied in placeholder position as an array.
+ *
+ * Note: at least one argument must be the placeholder
+ */
+declare function curryArgs3(baseFunc: any, arg0: any, arg1: any, arg2: any): (...args: any[]) => any;

package/_internal/curryArgs4.d.ts

@@ -0,0 +1,23 @@
+export = curryArgs4;
+/**
+ * @name curryArgs4
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * __ = Symbol('placeholder')
+ *
+ * curryArgs4(
+ *   baseFunc function,
+ *   arg0 __|any,
+ *   arg1 __|any,
+ *   arg2 __|any
+ *   arg3 __|any,
+ * ) -> function
+ * ```
+ *
+ * @description
+ * Curry arguments for a 4-ary function. Arguments are supplied in placeholder position as an array.
+ *
+ * Note: at least one argument must be the placeholder
+ */
+declare function curryArgs4(baseFunc: any, arg0: any, arg1: any, arg2: any, arg3: any): (...args: any[]) => any;

package/_internal/curryArity.d.ts

@@ -0,0 +1,20 @@
+export = curryArity;
+/**
+ * @name curryArity
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * __ = Symbol(placeholder)
+ *
+ * var arity number,
+ *   func function,
+ *   args Array<__|any>,
+ *   curried function
+ *
+ * curryArity(arity, func, args) -> curried|any
+ * ```
+ *
+ * @description
+ * Create a curried version of a function with specified arity.
+ */
+declare function curryArity(arity: any, func: any, args: any): any;

package/_internal/deleteByPath.d.ts

@@ -0,0 +1,13 @@
+export = deleteByPath;
+/**
+ * @name deleteByPath
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * deleteByPath<
+ *   object any,
+ *   path string|number|Array<string|number>,
+ * >(value, path) -> ()
+ * ```
+ */
+declare function deleteByPath(object: any, path: any): any;

package/_internal/equals.d.ts

@@ -0,0 +1,10 @@
+export = equals;
+/**
+ * @name equals
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * equals(left any, right any) -> boolean
+ * ```
+ */
+declare function equals(left: any, right: any): boolean;

package/_internal/funcApply.d.ts

@@ -0,0 +1,16 @@
+export = funcApply;
+/**
+ * @name funcApply
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * funcApply<
+ *   args ...any,
+ *   func ...args=>any,
+ * >(func, args) -> func(...args)
+ * ```
+ *
+ * @description
+ * Apply arguments to a function.
+ */
+declare function funcApply(func: any, args: any): any;

package/_internal/funcConcat.d.ts

@@ -0,0 +1,17 @@
+export = funcConcat;
+/**
+ * @name funcConcat
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * funcConcat<
+ *   args ...any,
+ *   intermediate any,
+ *   result any,
+ * >(
+ *   funcA ...args=>Promise|intermediate,
+ *   funcB intermediate=>result
+ * ) -> pipedFunction ...args=>Promise|result
+ * ```
+ */
+declare function funcConcat(funcA: any, funcB: any): (...args: any[]) => any;

package/_internal/funcConcatSync.d.ts

@@ -0,0 +1,17 @@
+export = funcConcatSync;
+/**
+ * @name funcConcatSync
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * funcConcatSync<
+ *   args ...any,
+ *   intermediate any,
+ *   result any,
+ * >(
+ *   funcA ...args=>intermediate,
+ *   funcB intermediate=>result
+ * ) -> pipedFunction ...args=>result
+ * ```
+ */
+declare function funcConcatSync(funcA: any, funcB: any): (...args: any[]) => any;

package/_internal/functionArrayAll.d.ts

@@ -0,0 +1,10 @@
+export = functionArrayAll;
+/**
+ * @name functionArrayAll
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * functionArrayAll(funcs Array<function>, args Array) -> Promise|Array
+ * ```
+ */
+declare function functionArrayAll(funcs: any, args: any): any;

package/_internal/functionArrayAllSeries.d.ts

@@ -0,0 +1,10 @@
+export = functionArrayAllSeries;
+/**
+ * @name functionArrayAllSeries
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * functionArrayAllSeries(funcs Array<function>, args Array) -> Promise|Array
+ * ```
+ */
+declare function functionArrayAllSeries(funcs: any, args: any): any;

package/_internal/functionObjectAll.d.ts

@@ -0,0 +1,13 @@
+export = functionObjectAll;
+/**
+ * @name functionObjectAll
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * functionObjectAll(funcs Array<function>, args Array) -> Promise|Object
+ * ```
+ *
+ * @description
+ * Concurrently execute the same arguments for each function of an object of functions, returning an object of results.
+ */
+declare function functionObjectAll(funcs: any, args: any): any;

package/_internal/genericReduce.d.ts

@@ -0,0 +1,26 @@
+export = genericReduce;
+/**
+ * @name genericReduce
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * Foldable<T> = Iterable<T>|AsyncIterable<T>
+ *   |{ reduce: (any, T)=>any }|Object<T>
+ *
+ * genericReduce<T>(
+ *   collection Foldable<T>,
+ *   reducer (any, T)=>any,
+ *   result any?,
+ * ) -> result
+ * ```
+ *
+ * @related genericReduceConcurrent
+ *
+ * @TODO genericReduceSync(collection, reducer, init) - performance optimization for some of these genericReduces that we know are synchronous
+ *
+ * @TODO genericReducePool(poolSize, collection, reducer, init) - for some of these genericReduces that we want to race - result should not care about order of concatenations
+ * reduce.pool
+ * transform.pool
+ * flatMap.pool
+ */
+declare function genericReduce(collection: any, reducer: any, result: any): any;

package/_internal/genericTransform.d.ts

@@ -0,0 +1,18 @@
+export = genericTransform;
+/**
+ * @name genericTransform
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * Reducer = (any, any)=>Promise|any
+ * Semigroup = Array|string|Set|TypedArray
+ *   |{ concat: function }|{ write: function }|Object
+ *
+ * genericTransform<
+ *   collection any,
+ *   transducer Reducer=>Reducer,
+ *   accum Semigroup|any,
+ * >(collection, transducer, accum) -> accum
+ * ```
+ */
+declare function genericTransform(collection: any, transducer: any, accum: any): any;

package/_internal/getArg1.d.ts

@@ -0,0 +1,8 @@
+export = getArg1;
+/**
+ * @name getArg1
+ *
+ * @synopsis
+ * getArg1(arg0 any, arg1 any) -> arg1
+ */
+declare function getArg1(arg0: any, arg1: any): any;