atomic-fns 1.1.1 → 1.1.2

package/README.md

@@ -2,7 +2,7 @@
 
 [Read the Docs](https://atomic-fns.dev)
 
-## Like Lodash, but in TypeScript and for ESnext.
+## Like Lodash, but in TypeScript and for ESNext.
 
 Stop shipping code built for browsers from 2015. Really though, look at all the [issues](https://github.com/lodash/lodash/issues/2930).
 
@@ -10,10 +10,10 @@ You may prefer this because it's:
 
 * **TypeScript & docs**: Includes type declaration files and js with JSDocs for best in class experience.
 * **Zero deps**: Built from scratch with no runtime dependencies or polyfills.
-* **ESnext**: Uses modern idiomatic syntax, data structures, and control flow techniques.
-* **Modular**: Pick what you need. Supports tree-shaking, no side effects and works with all bundlers.
+* **ESNext**: Uses modern idiomatic syntax, data structures, and control flow techniques.
+* **Modular**: Pick what you need. Supports tree-shaking, no side effects, and works with all bundlers.
 * **Lazy**: Leverage generators, iterators, and functional composition.
-* **Well tested**: All modules have comprehensive test suites and public apis are 100% coverage.
+* **Tests**: All modules have comprehensive test suites and public apis are 100% covered.
 
 ## Docs
 
@@ -52,7 +52,7 @@ See the full list of [modules](https://atomic-fns.dev/modules.html).
 ## Data model
 This library features a data model similar to [Python](https://docs.python.org/3/reference/datamodel.html#special-method-names) but not always. Only the missing parts have been implemented, while respecting the JS standards.
 
-For example in Python collections `size()` is a method while in JS its just a property. So this library uses `size` property instead of methods. Similarly, the `len` function implementation checks for both `length` and `size` since many JS objects have a `length` property.
+For example, in Python collections, `size()` is a method, while in JS it's just a property. So this library uses `size` property instead of method. Similarly, the `len` function implementation checks for both `length` and `size` since many JS objects have a `length` property.
 
 ## Special method names
 This library adds support for operators using object methods such as:
@@ -63,11 +63,13 @@ This library adds support for operators using object methods such as:
   - `obj.gte(other)`  adds custom `obj >= other`.
   - `obj.compare(other)`  overloads sorting operations.
 
-When you implement those, you can also apply operators to values like `eq(x, y), lte(x, y), compare(x, y)`, etc. to get the result of `x.<operator>(y)`.
+When working with objects, functions in this library use these custom operators for equality and sorting. You can also apply operators to values like `eq(x, y)`, `lte(x, y)`, `compare(x, y)`, etc.
 
 ## New Types
 
-Introduces some common base interfaces and typing patterns you may have seen like `Optional`, `Result`, `Comparable`, `Iterator`, and others.
+[`Decimal`](https://atomic-fns.dev/classes/decimal.Decimal.html) provides support for correct rounded floating point arithmetic, with arbitrary precision.
+
+Some common base interfaces and typing patterns you may have seen like `Optional`, `Result`, `Comparable`, `Iterator`, and others.
 
 ### Sorted Containers
   - [SortedSet](https://atomic-fns.dev/classes/Collections.SortedSet.html)

package/dist/collections/SortedMap.d.ts

@@ -1,8 +1,8 @@
 import { Mapping } from './abc.js';
 /**
  * A `SortedMap` is a map that holds key value pairs ordered by keys. Any primitive value (and objects that implement {@link Comparable} or {@link Ordered} interfaces) can be used as keys or values.
- * @see {@link Operators.compare}
- * @see {@link Operators.lt}
+ * @see {@link operators.compare}
+ * @see {@link operators.lt}
  * @template K, V
  */
 export declare class SortedMap<K, V> extends Mapping<K, V> {

package/dist/collections/SortedMap.js

@@ -2,8 +2,8 @@ import { Mapping } from './abc.js';
 import { SplayTree } from './SplayTree.js';
 /**
  * A `SortedMap` is a map that holds key value pairs ordered by keys. Any primitive value (and objects that implement {@link Comparable} or {@link Ordered} interfaces) can be used as keys or values.
- * @see {@link Operators.compare}
- * @see {@link Operators.lt}
+ * @see {@link operators.compare}
+ * @see {@link operators.lt}
  * @template K, V
  */
 export class SortedMap extends Mapping {

package/dist/collections/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * This module includes classes and functions to work with Container types.
  *
- * @module Collections
+ * @module collections
  */
 import { compare } from '../operators/index.js';
 import { Iteratee } from '../types';
@@ -15,6 +15,7 @@ export * from './SortedMap.js';
 export * from './SortedSet.js';
 export * from './SortedTree.js';
 export * from './SplayTree.js';
+export * from './Trie.js';
 /**
  * Creates a new array with all falsy and empty values removed.
  * @param arr The array to compact

package/dist/collections/index.js

@@ -1,7 +1,7 @@
 /**
  * This module includes classes and functions to work with Container types.
  *
- * @module Collections
+ * @module collections
  */
 import { call, get, isArray, isArrayLike, isBool, isEmpty, isFunction, isIterable, isNull, isNumber, isObject, isString, keys, set } from '../globals/index.js';
 import { enumerate } from '../itertools/index.js';
@@ -16,6 +16,7 @@ export * from './SortedMap.js';
 export * from './SortedSet.js';
 export * from './SortedTree.js';
 export * from './SplayTree.js';
+export * from './Trie.js';
 export function compact(arr) {
     if (!arr)
         return;

package/dist/decimal/index.d.ts

@@ -8,7 +8,9 @@
  */
 export declare function decimal(x: any): Decimal;
 /**
- * `Decimal` provides support for correct rounded floating point arithmetic, unlike the standard Number type. It also supports user-defined precision (default is 20 decimal places) which can be as large as needed.
+ * `Decimal` provides support for correct rounded floating point arithmetic, unlike the standard
+ * `Number` type. It also supports user-defined precision (default is 20 decimal places), which
+ * can be as large as needed.
  */
 export declare class Decimal {
     static PRECISION: number;
@@ -25,7 +27,7 @@ export declare class Decimal {
      * @example
   ```js
   let a = decimal('5')
-  a.minus()  // -5
+  a.negated()  // -5
   ```
      * @returns {Decimal}
      */

package/dist/decimal/index.js

@@ -11,7 +11,9 @@ export function decimal(x) {
     return new Decimal(x);
 }
 /**
- * `Decimal` provides support for correct rounded floating point arithmetic, unlike the standard Number type. It also supports user-defined precision (default is 20 decimal places) which can be as large as needed.
+ * `Decimal` provides support for correct rounded floating point arithmetic, unlike the standard
+ * `Number` type. It also supports user-defined precision (default is 20 decimal places), which
+ * can be as large as needed.
  */
 export class Decimal {
     static PRECISION = 20;
@@ -86,7 +88,7 @@ export class Decimal {
      * @example
   ```js
   let a = decimal('5')
-  a.minus()  // -5
+  a.negated()  // -5
   ```
      * @returns {Decimal}
      */

package/dist/functools/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * This module includes functions that promote a more functional programming style.
  *
- * @module Functions
+ * @module functools
  */
 import { Function } from '../globals/index.js';
 /**

package/dist/functools/index.js

@@ -1,7 +1,7 @@
 /**
  * This module includes functions that promote a more functional programming style.
  *
- * @module Functions
+ * @module functools
  */
 /**
  * Creates a function that invokes `fn` with the this binding of `thisArg` and `partials` as partially applied arguments.

package/dist/globals/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * This module includes global functions and constants.
  *
- * @module Globals
+ * @module globals
  */
 /**
  * A generic function type with arbitrary arguments and return.

package/dist/globals/index.js

@@ -1,7 +1,7 @@
 /**
  * This module includes global functions and constants.
  *
- * @module Globals
+ * @module globals
  */
 /** This is just a noop function. */
 export const noop = () => { };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './collections/index.js';
+export * from './decimal/index.js';
 export * from './functools/index.js';
 export * from './globals/index.js';
 export * from './i18n/index.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './collections/index.js';
+export * from './decimal/index.js';
 export * from './functools/index.js';
 export * from './globals/index.js';
 export * from './i18n/index.js';

package/dist/itertools/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * This module includes functions that deal with or produce iterators.
  *
- * @module Iterators
+ * @module itertools
  */
 import { add, Comparer } from '../operators/index.js';
 import { Function, Iteratee, Predicate } from '../types';
@@ -72,7 +72,7 @@ contains('abcd', 'bc')
 // true
 ```
  *
- * @see {@link Collections.find}
+ * @see {@link collections.find}
  */
 export declare function contains(collection: Iterable<any>, value: any): any;
 /**

package/dist/itertools/index.js

@@ -1,7 +1,7 @@
 /**
  * This module includes functions that deal with or produce iterators.
  *
- * @module Iterators
+ * @module itertools
  */
 import { call, isEmpty, isObject, notNull, ValueError } from '../globals/index.js';
 import { add, bool, compare, eq, id } from '../operators/index.js';
@@ -99,7 +99,7 @@ contains('abcd', 'bc')
 // true
 ```
  *
- * @see {@link Collections.find}
+ * @see {@link collections.find}
  */
 export function contains(collection, value) {
     if (!collection)

package/dist/math/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Math and algebraic operations.
  *
- * @module Math
+ * @module math
  */
 import { Predicate } from '../types.js';
 /**

package/dist/math/index.js

@@ -1,7 +1,7 @@
 /**
  * Math and algebraic operations.
  *
- * @module Math
+ * @module math
  */
 import { call } from '../globals/index.js';
 import { reduce } from '../itertools/index.js';

package/dist/operators/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Generic operations for both values and objects.
  *
- * @module Operators
+ * @module operators
  */
 /** This is the identity function. It always returns the same value that was passed in */
 export declare const id: (x: any) => any;
@@ -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 Operators.eq}
- * @see {@link Operators.lt}
+ * @see {@link operators.eq}
+ * @see {@link operators.lt}
  */
 export declare function compare(x: any, y: any): number;
 /**

package/dist/operators/index.js

@@ -1,7 +1,7 @@
 /**
  * Generic operations for both values and objects.
  *
- * @module Operators
+ * @module operators
  */
 import { call, isObject } from '../globals/index.js';
 /** This is the identity function. It always returns the same value that was passed in */
@@ -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 Operators.eq}
- * @see {@link Operators.lt}
+ * @see {@link operators.eq}
+ * @see {@link operators.lt}
  */
 export function compare(x, y) {
     if (x === y || eq(x, y))

package/dist/random/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * This module implements pseudo-random generators for various distributions.
  *
- * @module Random
+ * @module random
  */
 /**
  * Returns a random float between a [min, max) value (max exclusive).

package/dist/random/index.js

@@ -1,7 +1,7 @@
 /**
  * This module implements pseudo-random generators for various distributions.
  *
- * @module Random
+ * @module random
  */
 import { isObject } from '../globals/index.js';
 /**

package/dist/types.d.ts

@@ -4,16 +4,16 @@
 export declare type Function<TReturn = any> = (...args: any) => TReturn;
 /**
  * An iteratee function used for collection methods.
- * @see {@link Collections.filter}
- * @see {@link Collections.find}
- * @see {@link Collections.forEach}
- * @see {@link Collections.index}
- * @see {@link Collections.map}
- * @see {@link Collections.pick}
- * @see {@link Collections.omit}
- * @see {@link Collections.uniq}
- * @see {@link Collections.sortedUniq}
- * @see {@link Collections.groupBy}
+ * @see {@link collections.filter}
+ * @see {@link collections.find}
+ * @see {@link collections.forEach}
+ * @see {@link collections.index}
+ * @see {@link collections.map}
+ * @see {@link collections.pick}
+ * @see {@link collections.omit}
+ * @see {@link collections.uniq}
+ * @see {@link collections.sortedUniq}
+ * @see {@link collections.groupBy}
  */
 export declare type Iteratee<T = any, K = any, TResult = any> = (value: T, key?: K, arr?: any) => TResult;
 export declare type Predicate<T = any, TReturn = any> = (value: T) => TReturn;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "atomic-fns",
   "description": "Like Lodash, but for ESNext and with types. Stop shipping code built for browsers from 2015.",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "files": [
     "dist/*"
   ],
@@ -67,5 +67,5 @@
   "bugs": {
     "url": "https://github.com/adrian2x/atomic-fns/issues"
   },
-  "homepage": "https://github.com/adrian2x/atomic-fns#readme"
+  "homepage": "https://atomic-fns.dev"
 }