atomic-fns 0.3.5 → 0.4.3

package/{core → dist}/itertools/index.d.ts

@@ -21,17 +21,17 @@ export declare function accumulate<T>(iterable: Iterable<T>, func?: typeof add,
  * @example
 ```js
 all([0])
-// => true
+// true
 
 all([1, 2, 3])
-// => true
+// true
 
 all([2, 4, 6] => (n) => n > 1)
-// => true
+// true
 ```
 @see {@link any}
  */
-export declare const all: <T>(iterable: Iterable<T>, fn?: Predicate<T>) => boolean;
+export declare const all: <T>(iterable: Iterable<T>, fn?: Predicate<T, any>) => boolean;
 /**
  * Returns true when any of the items in iterable are truthy. An optional predicate function can be used to define what truthiness means for this specific collection.
  * @param iterable
@@ -40,17 +40,17 @@ export declare const all: <T>(iterable: Iterable<T>, fn?: Predicate<T>) => boole
  * @example
 ```js
 any([0])
-// => false
+// false
 
 any([0, 1, null, undefined])
-// => true
+// true
 
 any([1, 4, 5] => (n) => n % 2 === 0)
-// => true
+// true
 ```
 @see {@link all}
  */
-export declare const any: <T>(iterable: Iterable<T>, fn?: Predicate<T>) => boolean;
+export declare const any: <T>(iterable: Iterable<T>, fn?: Predicate<T, any>) => boolean;
 export declare function chain<T>(...iterables: Array<Iterable<T>>): Generator<T, void, unknown>;
 /**
  * Checks if the `value` is in `collection`.
@@ -60,16 +60,16 @@ export declare function chain<T>(...iterables: Array<Iterable<T>>): Generator<T,
  * @example
 ```js
 contains([1, 2, 3], 1)
-// => true
+// true
 
 contains([1, 2, 3], 1, 2)
-// => false
+// false
 
 contains({ 'a': 1, 'b': 2 }, 1)
-// => true
+// true
 
 contains('abcd', 'bc')
-// => true
+// true
 ```
  *
  * @see {@link Collections.find}
@@ -81,9 +81,9 @@ export declare function contains(collection: Iterable<any>, value: any): any;
  * @param predicate A function invoked per element to check if it should be dropped.
  * @returns Elements
  */
-export declare function dropWhile<T>(iterable: Iterable<T>, predicate: Predicate): Generator<unknown, any, unknown>;
+export declare function dropWhile<T>(iterable: Iterable<T>, predicate: Predicate<T>): Generator<T, T, unknown>;
 export declare function iforEach<T>(iterable: Iterable<T>, fun: Iteratee<T>): void;
-export declare function IterableIterator<T = any>(next: any): Iterator<T, any, undefined> & Iterable<T>;
+export declare function IterableIterator<T = any>(next: Iterator<T>['next']): Iterable<T> & Iterator<T>;
 /**
  * Yields elements like `[index, item]` from an iterable. Index starts at zero by default.
  * @template T
@@ -93,20 +93,20 @@ export declare function IterableIterator<T = any>(next: any): Iterator<T, any, u
  * @example
 ```js
 console.log([...enumerate(['hello', 'world'])])
-// => [[0, 'hello'], [1, 'world']]
+// [[0, 'hello'], [1, 'world']]
 
 // Start with index `1`
 console.log([...enumerate(['hello', 'world'], 1)])
-// => [[1, 'hello'], [2, 'world']]
+// [[1, 'hello'], [2, 'world']]
 ```
  */
-export declare function enumerate<T = any>(iterable: Iterable<T>, start?: number): Generator<(number | T)[], void, unknown>;
+export declare function enumerate<T>(iterable: Iterable<T>, start?: number): Generator<[number, T], void, unknown>;
 /**
  * Returns the first element in an iterable.
  * @param iterable The iterable to inspect.
  * @returns The first element found or undefined if iterable is empty.
  */
-export declare function first<T>(iterable: Iterable<T>): any;
+export declare function first<T>(iterable: Iterable<T>): T;
 /**
  * Creates a new generator that filters all falsy and empty values from iterable.
  * @param arr The array to compact
@@ -114,35 +114,35 @@ export declare function first<T>(iterable: Iterable<T>): any;
  * @example
 ```js
 compact([0, 1, false, 2, '', 3])
-// => [1, 2, 3]
+// [1, 2, 3]
 ```
  */
 export declare function icompact<T>(iterable: Iterable<T>): Generator<T, void, unknown>;
 /**
  * Iterates over elements of collection, producing only those elements where predicate returns a `truthy` value.
  */
-export declare function ifilter<T>(iterable: Iterable<T>, predicate: Predicate): Generator<T, void, unknown>;
-export declare function imap<T, TReturn = any>(iterable: Iterable<T>, mapFn: (x: T) => TReturn): Generator<TReturn, void, unknown>;
+export declare function ifilter<T>(iterable: Iterable<T>, predicate: Predicate<T, boolean>): Generator<T, void, unknown>;
+export declare function imap<T, TReturn = any>(iterable: Iterable<T>, mapFn: Predicate<T, TReturn>): Generator<TReturn, void, unknown>;
 /**
  * Returns a generator flattening one level of nesting in a list of lists.
  * @param iterables The iterable to flatten
  * @example
 ```js
 [...iflatten([[0, 1], [2, 3]])]
-// => [0, 1, 2, 3]
+// [0, 1, 2, 3]
 ```
  */
 export declare function iflatten<T = any>(iterables: Iterable<Iterable<T>>): Generator<T, void, unknown>;
 export declare function flatMap<T>(iterable: Iterable<T>, mapFn?: (x: T) => any): Generator<T, void, unknown>;
-export declare function islice<T>(iterable: Iterable<T>, start: number, stop?: number, step?: number): Generator<number | T, number | T | undefined, unknown>;
-export declare function itake<T>(n: number, iterable: Iterable<T>): Generator<unknown, void, unknown>;
+export declare function islice<T>(iterable: Iterable<T>, start: number, stop?: number, step?: number): Generator<T, T, unknown>;
+export declare function itake<T>(n: number, iterable: Iterable<T>): Generator<T, void, unknown>;
 /**
  * Returns an Iterator from the elements of a collection or the object keys.
  * @param obj The given collection to iterate over.
  * @returns An Iterator type.
  */
-export declare function iter<T>(obj: any): Iterator<T>;
-export declare function partition<T>(iterable: Iterable<T>, predicate: Predicate<T>): T[][];
+export declare function iter<T>(obj: any): Iterator<T, T>;
+export declare function partition<T>(iterable: Iterable<T>, predicate: Predicate<T, boolean>): [T[], T[]];
 /**
  * Returns a generator for a sequence of numbers in the given range, starting from `start` (default 0) to `stop` (not-inclusive) in increments of `step` (default 1).
  *
@@ -151,19 +151,19 @@ export declare function partition<T>(iterable: Iterable<T>, predicate: Predicate
  * @example
 ```js
 range(5)
-// => [0, 1, 2, 3, 4]
+// [0, 1, 2, 3, 4]
 
 range(2, 5)
-// => [2, 3, 4]
+// [2, 3, 4]
 
 range(0, 5, 2)
-// => [0, 2, 4]
+// [0, 2, 4]
 
 range(5, 0, -1)
-// => [5, 4, 3, 2, 1]
+// [5, 4, 3, 2, 1]
 
 range(-3)
-// => []
+// []
 ```
  */
 export declare function range(...args: number[]): Generator<number, void, unknown>;
@@ -176,7 +176,7 @@ export declare function range(...args: number[]): Generator<number, void, unknow
  * @example
 ```js
 reduce([1, 2, 3, 4, 5], (x, y) => x + y, 0)
-// => 15
+// 15
 ```
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce Array.reduce()}
  */
@@ -187,23 +187,51 @@ export declare function reduce<T>(iterable: Iterable<T>, reducer: (prev: T, valu
  * @returns A new array with the elements reversed.
  */
 export declare function reversed<T>(iterable: Iterable<T>): T[];
-export declare function sorted(args: any[]): any[];
-export declare function sorted(args: any[], reverse: boolean): any[];
-export declare function sorted(args: any[], reverse: boolean, comp: Comparer): any[];
-export declare function sorted(args: any[], key: Function): any[];
-export declare function sorted(args: any[], key: Function, reverse: boolean): any[];
-export declare function sort(args: any[]): any[];
-export declare function sort(args: any[], reverse: boolean): any[];
-export declare function sort(args: any[], compareFn: Comparer): any[];
-export declare function sort(args: any[], reverse: boolean, compareFn: Comparer): any[];
-export declare function take<T>(n: number, iterable: Iterable<T>): unknown[];
+/**
+ * Creates a new sorted list from the elements in the array. This can be called many ways:
+ *   - sorted([...], true) => reverse order
+ *   - sorted([...], fn = (x) => any) => using a key fn
+ *   - sorted([...], fn = (x) => any, true) => reverse order using key
+ *   - sorted([...], false, (x, y) => number) => using custom compare
+ *   - sorted([...], fn = (x) => any, true, (x, y) => number) => custom key, reverse and compare
+ *
+ * If `args` is an Object, returns the sorted keys.
+ *
+ *
+ * @param {(Array | Object)} args
+ * @param {(boolean | Function)} [key]
+ * @param {(boolean | Comparer)} [reverse]
+ * @param {Comparer} [compareFn]
+ * @return
+ */
+export declare function sorted<T>(args: T[]): T[];
+export declare function sorted<T>(args: T[], reverse: boolean): T[];
+export declare function sorted<T>(args: T[], reverse: boolean, comp: Comparer): T[];
+export declare function sorted<T>(args: T[], key: Function): T[];
+export declare function sorted<T>(args: T[], key: Function, reverse: boolean): T[];
+/**
+ * Sort `args` in place. Can be called like this:
+ *   - sort([...], true) => reverse order
+ *   - sort([...], (x, y) => number) => using custom compare
+ *   - sort([...], true, (x, y) => number) => reverse and using custom compare
+ *
+ * @param {any[]} args
+ * @param {(boolean | Comparer)} [reverse]
+ * @param {Comparer} [compareFn]
+ * @return
+ */
+export declare function sort<T>(args: T[]): T[];
+export declare function sort<T>(args: T[], reverse: boolean): T[];
+export declare function sort<T>(args: T[], compareFn: Comparer): T[];
+export declare function sort<T>(args: T[], reverse: boolean, compareFn: Comparer): T[];
+export declare function take<T>(n: number, iterable: Iterable<T>): T[];
 /**
  * Returns a generator that takes elements from the iterable as long as the predicate is `true`.
  * @param iterable The iterable to inspect.
  * @param predicate A function invoked per element to check if it should be taken.
  * @returns Elements
  */
-export declare function takeWhile<T>(iterable: Iterable<T>, predicate: Predicate): Generator<T, void, unknown>;
+export declare function takeWhile<T>(iterable: Iterable<T>, predicate: Predicate<T>): Generator<T, void, unknown>;
 /** Returns a generator that calls `fn(index)` for each index < n */
 /**
  * Returns a generator that produces `fn(index)` for each `index < n`.
@@ -219,9 +247,9 @@ export declare function times(n: number, fn: (index: number) => any): Generator<
 ```js
 for item of zip([1, 2, 3], ['sugar', 'spice', 'nice'])
   console.log(item)
-// => [1, 'sugar']
-// => [2, 'spice']
-// => [3, 'nice']
+// [1, 'sugar']
+// [2, 'spice']
+// [3, 'nice']
 ```
  */
 export declare function zip(...args: Array<Iterable<any>>): Generator<any[], void, unknown>;

package/{core → dist}/itertools/index.js

@@ -34,13 +34,13 @@ export function* accumulate(iterable, func = add, initial) {
  * @example
 ```js
 all([0])
-// => true
+// true
 
 all([1, 2, 3])
-// => true
+// true
 
 all([2, 4, 6] => (n) => n > 1)
-// => true
+// true
 ```
 @see {@link any}
  */
@@ -59,13 +59,13 @@ export const all = (iterable, fn = bool) => {
  * @example
 ```js
 any([0])
-// => false
+// false
 
 any([0, 1, null, undefined])
-// => true
+// true
 
 any([1, 4, 5] => (n) => n % 2 === 0)
-// => true
+// true
 ```
 @see {@link all}
  */
@@ -87,16 +87,16 @@ export function chain(...iterables) {
  * @example
 ```js
 contains([1, 2, 3], 1)
-// => true
+// true
 
 contains([1, 2, 3], 1, 2)
-// => false
+// false
 
 contains({ 'a': 1, 'b': 2 }, 1)
-// => true
+// true
 
 contains('abcd', 'bc')
-// => true
+// true
 ```
  *
  * @see {@link Collections.find}
@@ -109,7 +109,6 @@ export function contains(collection, value) {
         return includes;
     return any(collection, (x) => eq(value, x));
 }
-const compKey = (compare, key) => (x, y) => compare(key(x), key(y));
 /**
  * Returns a generator that drops elements from the iterable as long as the predicate is `true`; afterwards, returns every remaining element. Note, the generator does not produce any output until the predicate first becomes `false`.
  * @param iterable The iterable to inspect.
@@ -142,13 +141,12 @@ export function iforEach(iterable, fun) {
     }
 }
 export function IterableIterator(next) {
-    const it = {
+    return {
         next,
         [Symbol.iterator]() {
             return this;
         }
     };
-    return it;
 }
 /**
  * Yields elements like `[index, item]` from an iterable. Index starts at zero by default.
@@ -159,11 +157,11 @@ export function IterableIterator(next) {
  * @example
 ```js
 console.log([...enumerate(['hello', 'world'])])
-// => [[0, 'hello'], [1, 'world']]
+// [[0, 'hello'], [1, 'world']]
 
 // Start with index `1`
 console.log([...enumerate(['hello', 'world'], 1)])
-// => [[1, 'hello'], [2, 'world']]
+// [[1, 'hello'], [2, 'world']]
 ```
  */
 export function* enumerate(iterable, start = 0) {
@@ -187,7 +185,7 @@ export function first(iterable) {
  * @example
 ```js
 compact([0, 1, false, 2, '', 3])
-// => [1, 2, 3]
+// [1, 2, 3]
 ```
  */
 export function* icompact(iterable) {
@@ -216,7 +214,7 @@ export function* imap(iterable, mapFn) {
  * @example
 ```js
 [...iflatten([[0, 1], [2, 3]])]
-// => [0, 1, 2, 3]
+// [0, 1, 2, 3]
 ```
  */
 export function* iflatten(iterables) {
@@ -287,19 +285,19 @@ export function partition(iterable, predicate) {
  * @example
 ```js
 range(5)
-// => [0, 1, 2, 3, 4]
+// [0, 1, 2, 3, 4]
 
 range(2, 5)
-// => [2, 3, 4]
+// [2, 3, 4]
 
 range(0, 5, 2)
-// => [0, 2, 4]
+// [0, 2, 4]
 
 range(5, 0, -1)
-// => [5, 4, 3, 2, 1]
+// [5, 4, 3, 2, 1]
 
 range(-3)
-// => []
+// []
 ```
  */
 export function* range(...args) {
@@ -333,7 +331,7 @@ export function* range(...args) {
  * @example
 ```js
 reduce([1, 2, 3, 4, 5], (x, y) => x + y, 0)
-// => 15
+// 15
 ```
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce Array.reduce()}
  */
@@ -353,26 +351,11 @@ export function reduce(iterable, reducer, initial) {
 export function reversed(iterable) {
     return Array.from(iterable).reverse();
 }
-/**
- * Creates a new sorted list from the elements in the array. This can be called many ways:
- *   - sorted([...], true) => reverse order
- *   - sorted([...], fn = (x) => any) => using a key fn
- *   - sorted([...], fn = (x) => any, true) => reverse order using key
- *   - sorted([...], false, (x, y) => number) => using custom compare
- *   - sorted([...], fn = (x) => any, true, (x, y) => number) => custom key, reverse and compare
- *
- * If `args` is an Object, returns the sorted keys.
- *
- *
- * @param {(Array | Object)} args
- * @param {(boolean | Function)} [key]
- * @param {(boolean | Comparer)} [reverse]
- * @param {Comparer} [compareFn]
- * @return
- */
+const compKey = (compare, key) => (x, y) => compare(key(x), key(y));
 export function sorted(args, key, reverse, compareFn) {
-    if (isObject(args))
+    if (isObject(args)) {
         args = Object.keys(args);
+    }
     if (typeof key === 'boolean') {
         if (typeof reverse === 'function') {
             compareFn = reverse;
@@ -390,24 +373,13 @@ export function sorted(args, key, reverse, compareFn) {
         copy.reverse();
     return copy;
 }
-/**
- * Sort `args` in place. Can be called like this:
- *   - sort([...], true) => reverse order
- *   - sort([...], (x, y) => number) => using custom compare
- *   - sort([...], true, (x, y) => number) => reverse and using custom compare
- *
- * @param {any[]} args
- * @param {(boolean | Comparer)} [reverse]
- * @param {Comparer} [compareFn]
- * @return
- */
 export function sort(args, reverse, compareFn) {
     if (typeof reverse === 'function') {
         compareFn = reverse;
         reverse = false;
     }
     args.sort(compareFn || compare);
-    if (reverse === true)
+    if (reverse)
         args.reverse();
     return args;
 }
@@ -445,9 +417,9 @@ export function* times(n, fn) {
 ```js
 for item of zip([1, 2, 3], ['sugar', 'spice', 'nice'])
   console.log(item)
-// => [1, 'sugar']
-// => [2, 'spice']
-// => [3, 'nice']
+// [1, 'sugar']
+// [2, 'spice']
+// [3, 'nice']
 ```
  */
 export function* zip(...args) {

package/{core → dist}/math/index.d.ts

@@ -43,7 +43,7 @@ export declare const ceil: (x: number) => number;
  * @param y
  * @returns
  */
-export declare function divmod(x: number, y: number): number[];
+export declare function divmod(x: number, y: number): [number, number];
 export declare function log2(x: any): number;
 export declare function logBase(x: any, y: any): number;
 /**
@@ -66,18 +66,18 @@ export declare function max<T>(iterable: Iterable<T>, key?: Predicate<T>): T;
  * Computes the mean of the values in `iterable` and accepts an optional `key` function which is invoked for each element to generate the values to be averaged.
  * @param {Array<number>|Iterable<T>} iterable
  * @param {Function} [key] Optional iteratee invoked per element.
- * @returns Returns the mean value or `false` if no elements.
+ * @returns Returns the mean value or `NaN` if no elements.
  * @template T
  * @example
 ```js
 let objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }]
 
 mean(objects, (o) => o.n)
-// => 5
+// 5
 ```
  */
-export declare function mean(iterable: number[]): false | number;
-export declare function mean<T>(iterable: Iterable<T>, key?: Predicate<T>): false | number;
+export declare function mean(iterable: number[]): number;
+export declare function mean<T>(iterable: Iterable<T>, key?: Predicate<T>): number;
 /**
  * Sums `initial` and the items of an iterable and returns the total.
  * @param args The elements to add to `initial`.
@@ -86,12 +86,11 @@ export declare function mean<T>(iterable: Iterable<T>, key?: Predicate<T>): fals
  * @example
 ```js
 sum([1, 2, 3, 4])
-// => 10
+// 10
 
 sum([1, 2, 3, 4], 5)
-// => 15
+// 15
 ```
  */
-export declare function sum(iterable: number[]): number;
-export declare function sum<T>(iterable: Iterable<T>, key?: Predicate<T>): T;
-export declare function sum<T>(iterable: Iterable<T>, key?: Predicate<T>): T;
+export declare function sum(args: number[]): number;
+export declare function sum<T>(args: Iterable<T>, key?: Predicate<T>): number;

package/{core → dist}/math/index.js

@@ -81,7 +81,9 @@ export function mean(iterable, key = id) {
         total += key(value);
         count++;
     }
-    return count !== 0 && total / count;
+    if (count !== 0)
+        return total / count;
+    return Number.NaN;
 }
 export function sum(args, key = id) {
     let initial = 0;

package/{core → dist}/operators/index.d.ts

@@ -35,8 +35,8 @@ export declare type Comparer<T = any> = (x: T, y: T) => number;
  * @param {*} y Other value to compare
  * @returns {number} The comparison result
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#parameters Array.sort()}
- * @see {@link eq}
- * @see {@link lt}
+ * @see {@link Operators.eq}
+ * @see {@link Operators.lt}
  */
 export declare function compare(x: any, y: any): number;
 /**
@@ -72,7 +72,7 @@ export declare function lte(x: any, y: any): boolean;
  * @param {*} y
  * @returns {boolean} `true` if `x` is strictly greater than `y` or `false` otherwise.
  */
-export declare function gt(x: any, y: any): any;
+export declare function gt(x: any, y: any): boolean;
 /**
  * Compares two values to check if `x >= y`. If `x` is an object with a `gte` method, it returns `x.gte(y)`, also checks `x.eq(y)` and `x.gt(y)`.
  * Otherwise it returns the result of `x >= y`.
@@ -145,4 +145,4 @@ export declare function shallowEqual(obj: any, other: any): boolean;
  * @param other
  * @returns `true` if the objects are considered equal.
  */
-export declare function deepEqual(obj: any, other: any, checker?: typeof eq, seen?: WeakSet<object>): boolean;
+export declare function deepEqual(obj: any, other: any, checker?: Function, seen?: any): boolean;

package/{core → dist}/operators/index.js

@@ -36,8 +36,8 @@ export const isinstance = (x, y) => x instanceof y;
  * @param {*} y Other value to compare
  * @returns {number} The comparison result
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#parameters Array.sort()}
- * @see {@link eq}
- * @see {@link lt}
+ * @see {@link Operators.eq}
+ * @see {@link Operators.lt}
  */
 export function compare(x, y) {
     if (x === y || eq(x, y))
@@ -231,12 +231,6 @@ export function shallowEqual(obj, other) {
     }
     return false;
 }
-/**
- * Performs a recursive comparison of two objects or arrays to check if they have the same keys, length and values. Unlike {@link shallowEqual} this method compares nested values also.
- * @param obj
- * @param other
- * @returns `true` if the objects are considered equal.
- */
 export function deepEqual(obj, other, checker = eq, seen = new WeakSet()) {
     if (checker(obj, other))
         return true;

package/{core → dist}/random/index.d.ts

@@ -22,7 +22,7 @@ export declare const randomInt: (min?: number, max?: number) => number;
  * @returns {T}
  * @template T
  */
-export declare const choice: <T>(arr: T[]) => T | undefined;
+export declare function choice<T>(arr: T[]): T;
 /**
  * Returns a random sample of size k from a list of items.
  * @param {Array} arr

package/{core → dist}/random/index.js

@@ -23,11 +23,11 @@ export const randomInt = (min = 0, max = 1) => Math.round(random(min, max));
  * @returns {T}
  * @template T
  */
-export const choice = (arr) => {
-    if (!arr || !arr.length)
+export function choice(arr) {
+    if (!arr?.length)
         return;
     return arr[randomInt(0, arr.length - 1)];
-};
+}
 /**
  * Returns a random sample of size k from a list of items.
  * @param {Array} arr
@@ -36,7 +36,7 @@ export const choice = (arr) => {
  * @template T
  */
 export function sample(arr, size) {
-    if (!arr || !arr.length || arr.length < size)
+    if (!arr?.length || arr.length < size)
         return [];
     return shuffle(arr.slice()).slice(-size);
 }
@@ -49,7 +49,7 @@ export function sample(arr, size) {
  * @template T
  */
 export function shuffle(arr, size) {
-    if (!arr || !arr.length)
+    if (!arr?.length)
         return arr;
     if (isObject(arr))
         arr = Object.values(arr);