@rimbu/common 2.0.1 → 2.0.3

package/dist/cjs/eq.d.cts

@@ -3,6 +3,15 @@
  */
 export type Eq<T> = (v1: T, v2: T) => boolean;
 export declare namespace Eq {
+    /**
+     * Converts any given `value` to a string representation that is stable for equality
+     * and ordering comparisons.
+     *
+     * For primitive values and objects with a custom `toString` implementation, it uses
+     * `String(value)`. For plain objects with the default `Object.prototype.toString`
+     * implementation, it uses `JSON.stringify(value)` instead.
+     * @param value - the value to convert
+     */
     function convertAnyToString(value: any): string;
     /**
      * Returns the default Eq instance, which is the Eq.anyDeepEq() instance.
@@ -65,7 +74,7 @@ export declare namespace Eq {
     /**
      * Returns an Eq instance that checks equality of objects containing property values of type V by iteratively
      * applying given `valueEq` to each of the object's property values.
-     * @typeparam - the object property value type
+     * @typeparam V - the object property value type
      * @param valueEq - (optional) the Eq instance to use to compare property values
      * @example
      * ```ts
@@ -83,7 +92,7 @@ export declare namespace Eq {
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyFlatEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -98,7 +107,7 @@ export declare namespace Eq {
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyShallowEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -116,7 +125,7 @@ export declare namespace Eq {
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyDeepEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -164,6 +173,18 @@ export declare namespace Eq {
      * ```
      */
     function stringCharCodeEq(): Eq<string>;
+    /**
+     * Returns an Eq instance that considers two values equal when their string
+     * representations, as returned by `Eq.convertAnyToString`, are equal.
+     * @example
+     * ```ts
+     * const eq = Eq.anyToStringEq()
+     * console.log(eq({ a: 1 }, { a: 1 }))
+     * // => true
+     * console.log(eq({ a: 1 }, { a: 2 }))
+     * // => false
+     * ```
+     */
     function anyToStringEq(): Eq<any>;
     /**
      * Returns an Eq instance that considers values equal their JSON.stringify values are equal.

package/dist/cjs/err.cjs

@@ -1,20 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrBase = exports.Err = void 0;
+exports.ErrBase = void 0;
+exports.Err = Err;
 var tslib_1 = require("tslib");
 /**
- * Throws an `Err.ForcedError` error when called.
+ * Throws an `ErrBase.ForcedError` error when called.
  * @example
  * ```ts
  * const emptyMap = HashMap.empty<number, string>()
  * emptyMap.get(5, Err);
- * // throws: Err.CustomError(message: 'Err: forced to throw error')
+ * // throws: ErrBase.ForcedError(message: 'Err: Forced to throw error')
  * ```
  */
 function Err() {
     return ErrBase.msg('Err: Forced to throw error')();
 }
-exports.Err = Err;
 var ErrBase;
 (function (ErrBase) {
     /**
@@ -34,6 +34,9 @@ var ErrBase;
         return CustomError;
     }());
     ErrBase.CustomError = CustomError;
+    /**
+     * Error type that is thrown by `Err` and the functions returned by `ErrBase.msg`.
+     */
     var ForcedError = /** @class */ (function (_super) {
         tslib_1.__extends(ForcedError, _super);
         function ForcedError() {
@@ -49,7 +52,7 @@ var ErrBase;
      * ```ts
      * const emptyMap = HashMap.empty<number, string>()
      * emptyMap.get(5, ErrBase.msg('not found'));
-     * // throws: Err.CustomError(message: 'not found')
+     * // throws: ErrBase.ForcedError(message: 'not found')
      * ```
      */
     function msg(message) {

package/dist/cjs/err.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"err.cjs","sourceRoot":"","sources":["../../_cjs_prepare/err.cts"],"names":[],"mappings":";;;;AAAA;;;;;;;;GAQG;AACH,SAAgB,GAAG;IACjB,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,EAAE,CAAC;AACrD,CAAC;AAFD,kBAEC;AAED,IAAiB,OAAO,CA6BvB;AA7BD,WAAiB,OAAO;IACtB;;OAEG;IACH;QACE,qBAAqB,OAAe;YAAf,YAAO,GAAP,OAAO,CAAQ;QAAG,CAAC;QAExC,sBAAI,6BAAI;iBAAR;gBACE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAC/B,CAAC;;;WAAA;QACH,kBAAC;IAAD,CAAC,AAND,IAMC;IANqB,mBAAW,cAMhC,CAAA;IAED;QAAiC,uCAAW;QAA5C;;QAA8C,CAAC;QAAD,kBAAC;IAAD,CAAC,AAA/C,CAAiC,WAAW,GAAG;IAAlC,mBAAW,cAAuB,CAAA;IAE/C;;;;;;;;;OASG;IACH,SAAgB,GAAG,CAAC,OAAe;QACjC,OAAO;YACL,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;IACJ,CAAC;IAJe,WAAG,MAIlB,CAAA;AACH,CAAC,EA7BgB,OAAO,uBAAP,OAAO,QA6BvB"}
+{"version":3,"file":"err.cjs","sourceRoot":"","sources":["../../_cjs_prepare/err.cts"],"names":[],"mappings":";;;AASA,kBAEC;;AAXD;;;;;;;;GAQG;AACH,SAAgB,GAAG;IACjB,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,EAAE,CAAC;AACrD,CAAC;AAED,IAAiB,OAAO,CAgCvB;AAhCD,WAAiB,OAAO;IACtB;;OAEG;IACH;QACE,qBAAqB,OAAe;YAAf,YAAO,GAAP,OAAO,CAAQ;QAAG,CAAC;QAExC,sBAAI,6BAAI;iBAAR;gBACE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAC/B,CAAC;;;WAAA;QACH,kBAAC;IAAD,CAAC,AAND,IAMC;IANqB,mBAAW,cAMhC,CAAA;IAED;;OAEG;IACH;QAAiC,uCAAW;QAA5C;;QAA8C,CAAC;QAAD,kBAAC;IAAD,CAAC,AAA/C,CAAiC,WAAW,GAAG;IAAlC,mBAAW,cAAuB,CAAA;IAE/C;;;;;;;;;OASG;IACH,SAAgB,GAAG,CAAC,OAAe;QACjC,OAAO;YACL,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;IACJ,CAAC;IAJe,WAAG,MAIlB,CAAA;AACH,CAAC,EAhCgB,OAAO,uBAAP,OAAO,QAgCvB"}

package/dist/cjs/err.d.cts

@@ -1,10 +1,10 @@
 /**
- * Throws an `Err.ForcedError` error when called.
+ * Throws an `ErrBase.ForcedError` error when called.
  * @example
  * ```ts
  * const emptyMap = HashMap.empty<number, string>()
  * emptyMap.get(5, Err);
- * // throws: Err.CustomError(message: 'Err: forced to throw error')
+ * // throws: ErrBase.ForcedError(message: 'Err: Forced to throw error')
  * ```
  */
 export declare function Err(): never;
@@ -17,6 +17,9 @@ export declare namespace ErrBase {
         constructor(message: string);
         get name(): string;
     }
+    /**
+     * Error type that is thrown by `Err` and the functions returned by `ErrBase.msg`.
+     */
     class ForcedError extends CustomError {
     }
     /**
@@ -26,7 +29,7 @@ export declare namespace ErrBase {
      * ```ts
      * const emptyMap = HashMap.empty<number, string>()
      * emptyMap.get(5, ErrBase.msg('not found'));
-     * // throws: Err.CustomError(message: 'not found')
+     * // throws: ErrBase.ForcedError(message: 'not found')
      * ```
      */
     function msg(message: string): () => never;

package/dist/cjs/index.cjs

@@ -2,7 +2,13 @@
 /**
  * @packageDocumentation
  *
- * The `@rimbu/common` package provides many commonly used types and utilities that can also be of use to Rimbu users.<br/>
+ * The `@rimbu/common` package provides shared equality and comparison helpers, range and index
+ * utilities, lazy and async value helpers, traversal utilities, and rich type‑level helpers used
+ * throughout the Rimbu ecosystem.<br/>
+ * Use it when you need well‑tested primitives like `Eq`, `Comp`, `Range`, `OptLazy`, `AsyncOptLazy`,
+ * or advanced type utilities in your own code, or when building on top of other Rimbu packages.<br/>
+ * See the [Common docs](https://rimbu.org/docs/common/overview) and
+ * [API reference](https://rimbu.org/api/rimbu/common) for more information.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../_cjs_prepare/index.cts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,yDAA+B"}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../_cjs_prepare/index.cts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAEH,yDAA+B"}

package/dist/cjs/index.d.cts

@@ -1,6 +1,12 @@
 /**
  * @packageDocumentation
  *
- * The `@rimbu/common` package provides many commonly used types and utilities that can also be of use to Rimbu users.<br/>
+ * The `@rimbu/common` package provides shared equality and comparison helpers, range and index
+ * utilities, lazy and async value helpers, traversal utilities, and rich type‑level helpers used
+ * throughout the Rimbu ecosystem.<br/>
+ * Use it when you need well‑tested primitives like `Eq`, `Comp`, `Range`, `OptLazy`, `AsyncOptLazy`,
+ * or advanced type utilities in your own code, or when building on top of other Rimbu packages.<br/>
+ * See the [Common docs](https://rimbu.org/docs/common/overview) and
+ * [API reference](https://rimbu.org/api/rimbu/common) for more information.
  */
 export * from './internal.cjs';

package/dist/cjs/optlazy.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OptLazyOr = exports.OptLazy = void 0;
+exports.OptLazy = OptLazy;
+exports.OptLazyOr = OptLazyOr;
 var tslib_1 = require("tslib");
 /**
  * Returns the value contained in an `OptLazy` instance of type T.
@@ -24,7 +25,6 @@ function OptLazy(optLazy) {
         return optLazy.apply(void 0, tslib_1.__spreadArray([], tslib_1.__read(args), false));
     return optLazy;
 }
-exports.OptLazy = OptLazy;
 /**
  * Returns the value contained in an `OptLazyOr` instance of type T, or the given
  * `otherValue` if the lazy function returns it.
@@ -44,5 +44,4 @@ function OptLazyOr(optLazyOr, otherValue) {
         return optLazyOr(otherValue);
     return optLazyOr;
 }
-exports.OptLazyOr = OptLazyOr;
 //# sourceMappingURL=optlazy.cjs.map

package/dist/cjs/optlazy.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"optlazy.cjs","sourceRoot":"","sources":["../../_cjs_prepare/optlazy.cts"],"names":[],"mappings":";;;;AAOA;;;;;;;;;;;;GAYG;AACH,SAAgB,OAAO,CACrB,OAAsB;IACtB,cAAU;SAAV,UAAU,EAAV,qBAAU,EAAV,IAAU;QAAV,6BAAU;;IAEV,IAAI,OAAO,YAAY,QAAQ;QAAE,OAAO,OAAO,wDAAI,IAAI,WAAE;IACzD,OAAO,OAAO,CAAC;AACjB,CAAC;AAND,0BAMC;AAUD;;;;;;;;;;;;;GAaG;AACH,SAAgB,SAAS,CACvB,SAA0B,EAC1B,UAAa;IAEb,IAAI,SAAS,YAAY,QAAQ;QAAE,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;IAChE,OAAO,SAAS,CAAC;AACnB,CAAC;AAND,8BAMC"}
+{"version":3,"file":"optlazy.cjs","sourceRoot":"","sources":["../../_cjs_prepare/optlazy.cts"],"names":[],"mappings":";;AAoBA,0BAMC;AAwBD,8BAMC;;AAjDD;;;;;;;;;;;;GAYG;AACH,SAAgB,OAAO,CACrB,OAAsB;IACtB,cAAU;SAAV,UAAU,EAAV,qBAAU,EAAV,IAAU;QAAV,6BAAU;;IAEV,IAAI,OAAO,YAAY,QAAQ;QAAE,OAAO,OAAO,wDAAI,IAAI,WAAE;IACzD,OAAO,OAAO,CAAC;AACjB,CAAC;AAUD;;;;;;;;;;;;;GAaG;AACH,SAAgB,SAAS,CACvB,SAA0B,EAC1B,UAAa;IAEb,IAAI,SAAS,YAAY,QAAQ;QAAE,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;IAChE,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/cjs/traverse-state.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TraverseState = void 0;
+exports.TraverseState = TraverseState;
 var TraverseStateImpl = /** @class */ (function () {
     function TraverseStateImpl(startIndex) {
         var _this = this;
@@ -29,5 +29,4 @@ function TraverseState(startIndex) {
     if (startIndex === void 0) { startIndex = 0; }
     return new TraverseStateImpl(startIndex);
 }
-exports.TraverseState = TraverseState;
 //# sourceMappingURL=traverse-state.cjs.map

package/dist/cjs/traverse-state.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-state.cjs","sourceRoot":"","sources":["../../_cjs_prepare/traverse-state.cts"],"names":[],"mappings":";;;AA6BA;IAIE,2BAAqB,UAAkB;QAAvC,iBAEC;QAFoB,eAAU,GAAV,UAAU,CAAQ;QAFvC,WAAM,GAAG,KAAK,CAAC;QAUN,SAAI,GAAG;YACd,KAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC,CAAC;QATA,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,qCAAS,GAAT;QACE,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAMD,iCAAK,GAAL;QACE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IACH,wBAAC;AAAD,CAAC,AApBD,IAoBC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,UAAc;IAAd,2BAAA,EAAA,cAAc;IAC1C,OAAO,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAC;AAC3C,CAAC;AAFD,sCAEC"}
+{"version":3,"file":"traverse-state.cjs","sourceRoot":"","sources":["../../_cjs_prepare/traverse-state.cts"],"names":[],"mappings":";;AAwDA,sCAEC;AA7BD;IAIE,2BAAqB,UAAkB;QAAvC,iBAEC;QAFoB,eAAU,GAAV,UAAU,CAAQ;QAFvC,WAAM,GAAG,KAAK,CAAC;QAUN,SAAI,GAAG;YACd,KAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC,CAAC;QATA,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,qCAAS,GAAT;QACE,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAMD,iCAAK,GAAL;QACE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IACH,wBAAC;AAAD,CAAC,AApBD,IAoBC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,UAAc;IAAd,2BAAA,EAAA,cAAc;IAC1C,OAAO,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAC;AAC3C,CAAC"}

package/dist/cjs/update.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Update = void 0;
+exports.Update = Update;
 /**
  * Returns the result of given `update` parameter, where it can either directly give a new value,
  * or it is a function receiving the given `value`, and returns a new value.
@@ -20,5 +20,4 @@ function Update(value, update) {
     }
     return update;
 }
-exports.Update = Update;
 //# sourceMappingURL=update.cjs.map

package/dist/cjs/update.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"update.cjs","sourceRoot":"","sources":["../../_cjs_prepare/update.cts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;GAYG;AACH,SAAgB,MAAM,CAAI,KAAQ,EAAE,MAAiB;IACnD,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QACjC,OAAQ,MAA0B,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AALD,wBAKC"}
+{"version":3,"file":"update.cjs","sourceRoot":"","sources":["../../_cjs_prepare/update.cts"],"names":[],"mappings":";;AAkBA,wBAKC;AAlBD;;;;;;;;;;;;GAYG;AACH,SAAgB,MAAM,CAAI,KAAQ,EAAE,MAAiB;IACnD,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QACjC,OAAQ,MAA0B,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/esm/eq.d.mts

@@ -3,6 +3,15 @@
  */
 export type Eq<T> = (v1: T, v2: T) => boolean;
 export declare namespace Eq {
+    /**
+     * Converts any given `value` to a string representation that is stable for equality
+     * and ordering comparisons.
+     *
+     * For primitive values and objects with a custom `toString` implementation, it uses
+     * `String(value)`. For plain objects with the default `Object.prototype.toString`
+     * implementation, it uses `JSON.stringify(value)` instead.
+     * @param value - the value to convert
+     */
     function convertAnyToString(value: any): string;
     /**
      * Returns the default Eq instance, which is the Eq.anyDeepEq() instance.
@@ -65,7 +74,7 @@ export declare namespace Eq {
     /**
      * Returns an Eq instance that checks equality of objects containing property values of type V by iteratively
      * applying given `valueEq` to each of the object's property values.
-     * @typeparam - the object property value type
+     * @typeparam V - the object property value type
      * @param valueEq - (optional) the Eq instance to use to compare property values
      * @example
      * ```ts
@@ -83,7 +92,7 @@ export declare namespace Eq {
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyFlatEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -98,7 +107,7 @@ export declare namespace Eq {
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyShallowEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -116,7 +125,7 @@ export declare namespace Eq {
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyDeepEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -164,6 +173,18 @@ export declare namespace Eq {
      * ```
      */
     function stringCharCodeEq(): Eq<string>;
+    /**
+     * Returns an Eq instance that considers two values equal when their string
+     * representations, as returned by `Eq.convertAnyToString`, are equal.
+     * @example
+     * ```ts
+     * const eq = Eq.anyToStringEq()
+     * console.log(eq({ a: 1 }, { a: 1 }))
+     * // => true
+     * console.log(eq({ a: 1 }, { a: 2 }))
+     * // => false
+     * ```
+     */
     function anyToStringEq(): Eq<any>;
     /**
      * Returns an Eq instance that considers values equal their JSON.stringify values are equal.

package/dist/esm/eq.mjs

@@ -1,5 +1,14 @@
 export var Eq;
 (function (Eq) {
+    /**
+     * Converts any given `value` to a string representation that is stable for equality
+     * and ordering comparisons.
+     *
+     * For primitive values and objects with a custom `toString` implementation, it uses
+     * `String(value)`. For plain objects with the default `Object.prototype.toString`
+     * implementation, it uses `JSON.stringify(value)` instead.
+     * @param value - the value to convert
+     */
     function convertAnyToString(value) {
         if (typeof value !== 'object' ||
             null === value ||
@@ -129,7 +138,7 @@ export var Eq;
     /**
      * Returns an Eq instance that checks equality of objects containing property values of type V by iteratively
      * applying given `valueEq` to each of the object's property values.
-     * @typeparam - the object property value type
+     * @typeparam V - the object property value type
      * @param valueEq - (optional) the Eq instance to use to compare property values
      * @example
      * ```ts
@@ -200,7 +209,7 @@ export var Eq;
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyFlatEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -218,7 +227,7 @@ export var Eq;
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyShallowEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -239,7 +248,7 @@ export var Eq;
      * @typeparam T - the value type
      * @example
      * ```ts
-     * const eq = anyFlatEq()
+     * const eq = Eq.anyDeepEq()
      * console.log(eq(1, 'a'))
      * // => false
      * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -319,6 +328,18 @@ export var Eq;
     }
     Eq.stringCharCodeEq = stringCharCodeEq;
     const _anyToStringEq = (v1, v2) => convertAnyToString(v1) === convertAnyToString(v2);
+    /**
+     * Returns an Eq instance that considers two values equal when their string
+     * representations, as returned by `Eq.convertAnyToString`, are equal.
+     * @example
+     * ```ts
+     * const eq = Eq.anyToStringEq()
+     * console.log(eq({ a: 1 }, { a: 1 }))
+     * // => true
+     * console.log(eq({ a: 1 }, { a: 2 }))
+     * // => false
+     * ```
+     */
     function anyToStringEq() {
         return _anyToStringEq;
     }

package/dist/esm/eq.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"eq.mjs","sourceRoot":"","sources":["../../src/eq.mts"],"names":[],"mappings":"AAKA,MAAM,KAAW,EAAE,CAgZlB;AAhZD,WAAiB,EAAE;IACjB,SAAgB,kBAAkB,CAAC,KAAU;QAC3C,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,IAAI,KAAK,KAAK;YACd,CAAC,CAAC,UAAU,IAAI,KAAK,CAAC;YACtB,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU;YACpC,KAAK,CAAC,QAAQ,KAAK,MAAM,CAAC,SAAS,CAAC,QAAQ,EAC5C,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAZe,qBAAkB,qBAYjC,CAAA;IAED,MAAM,UAAU,GAAY,WAAW,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,aAAa,GAAY,WAAW,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,UAAU,GAAY,WAAW,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;OAUG;IACU,WAAQ,GAAY,MAAM,CAAC,EAAE,CAAC;IAE3C,MAAM,UAAU,GAA2B,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACpD,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAExC;;;;;;;;;;;;OAYG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM;QACpB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,SAAM,SAErB,CAAA;IAED,SAAS,gBAAgB,CAAI,MAAa;QACxC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YAChB,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEnC,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAEpC,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBAE5B,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI;oBAAE,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC;gBAEnE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;oBAAE,OAAO,KAAK,CAAC;YACxD,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAsB,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC;IAExE;;;;;;;;;;;;OAYG;IACH,SAAgB,UAAU,CAAI,MAAc;QAC1C,IAAI,SAAS,KAAK,MAAM;YAAE,OAAO,cAAc,CAAC;QAEhD,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAJe,aAAU,aAIzB,CAAA;IAED,SAAS,cAAc,CAAC,OAAgB;QACtC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YAChB,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEnC,IAAI,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW;gBAAE,OAAO,KAAK,CAAC;YAEpD,KAAK,MAAM,GAAG,IAAI,EAAE,EAAE,CAAC;gBACrB,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;oBAAE,OAAO,KAAK,CAAC;YACjC,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,EAAE,EAAE,CAAC;gBACrB,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;oBAAE,OAAO,KAAK,CAAC;YACjC,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,EAAE,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;gBACvB,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;gBAEvB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;oBAAE,OAAO,KAAK,CAAC;YAC7C,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAyB,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC;IAEpE;;;;;;;;;;;;;OAaG;IACH,SAAgB,QAAQ,CAAU,OAAe;QAC/C,IAAI,SAAS,KAAK,OAAO;YAAE,OAAO,SAAS,CAAC;QAE5C,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAJe,WAAQ,WAIvB,CAAA;IAED,SAAS,WAAW,CAAC,IAAiC;QACpD,MAAM,MAAM,GAAY,CAAC,EAAE,EAAE,EAAE,EAAW,EAAE;YAC1C,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEnC,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC;YAExB,IAAI,KAAK,KAAK,KAAK;gBAAE,OAAO,KAAK,CAAC;YAElC,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,WAAW,CAAC;gBACjB,KAAK,QAAQ,CAAC;gBACd,KAAK,SAAS,CAAC;gBACf,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC;gBACd,KAAK,UAAU;oBACb,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC3B,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI;wBAAE,OAAO,KAAK,CAAC;oBAE7C,IAAI,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,EAAE,CAAC;wBACtC,OAAO,KAAK,CAAC;oBACf,CAAC;oBAED,IACE,EAAE,YAAY,OAAO;wBACrB,EAAE,YAAY,IAAI;wBAClB,EAAE,YAAY,MAAM;wBACpB,EAAE,YAAY,MAAM,EACpB,CAAC;wBACD,OAAO,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBAC5B,CAAC;oBAED,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;wBACpB,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;4BACnD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gCACvB,OAAO,gBAAgB,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;4BAC9C,CAAC;4BAED,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC1C,CAAC;wBAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;4BACvB,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC5C,CAAC;wBAED,OAAO,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBAC3B,CAAC;oBAED,oDAAoD;oBACpD,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;;;;;;OAeG;IACH,SAAgB,YAAY;QAC1B,OAAO,aAAa,CAAC;IACvB,CAAC;IAFe,eAAY,eAE3B,CAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE9C,MAAM,wBAAwB,GAAY,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACnD,gBAAgB,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,SAAgB,sBAAsB,CACpC,GAAG,IAAiD;QAEpD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,wBAAwB,CAAC;QAEvD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAExC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;IARe,yBAAsB,yBAQrC,CAAA;IAED,MAAM,wBAAwB,GAAe,sBAAsB,CAAC,KAAK,EAAE;QACzE,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,SAAgB,uBAAuB;QACrC,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAFe,0BAAuB,0BAEtC,CAAA;IAED,MAAM,iBAAiB,GAAe,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;QAC/C,MAAM,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC;QAEtB,IAAI,GAAG,KAAK,EAAE,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAEpC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEX,OAAO,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC;YACjB,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;;;;;;;OAUG;IACH,SAAgB,gBAAgB;QAC9B,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAFe,mBAAgB,mBAE/B,CAAA;IAED,MAAM,cAAc,GAAY,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACzC,kBAAkB,CAAC,EAAE,CAAC,KAAK,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAEpD,SAAgB,aAAa;QAC3B,OAAO,cAAc,CAAC;IACxB,CAAC;IAFe,gBAAa,gBAE5B,CAAA;IAED,MAAM,UAAU,GAAY,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACrC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAE5C;;;;;;;;;;OAUG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAgB,cAAc,CAC5B,KAAY,SAAS,EAAE;QAEvB,OAAO,CAAC,IAAqB,EAAE,IAAqB,EAAW,EAAE,CAC/D,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IANe,iBAAc,iBAM7B,CAAA;AACH,CAAC,EAhZgB,EAAE,KAAF,EAAE,QAgZlB"}
+{"version":3,"file":"eq.mjs","sourceRoot":"","sources":["../../src/eq.mts"],"names":[],"mappings":"AAKA,MAAM,KAAW,EAAE,CAqalB;AAraD,WAAiB,EAAE;IACjB;;;;;;;;OAQG;IACH,SAAgB,kBAAkB,CAAC,KAAU;QAC3C,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,IAAI,KAAK,KAAK;YACd,CAAC,CAAC,UAAU,IAAI,KAAK,CAAC;YACtB,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU;YACpC,KAAK,CAAC,QAAQ,KAAK,MAAM,CAAC,SAAS,CAAC,QAAQ,EAC5C,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAZe,qBAAkB,qBAYjC,CAAA;IAED,MAAM,UAAU,GAAY,WAAW,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,aAAa,GAAY,WAAW,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,UAAU,GAAY,WAAW,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;OAUG;IACU,WAAQ,GAAY,MAAM,CAAC,EAAE,CAAC;IAE3C,MAAM,UAAU,GAA2B,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACpD,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAExC;;;;;;;;;;;;OAYG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM;QACpB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,SAAM,SAErB,CAAA;IAED,SAAS,gBAAgB,CAAI,MAAa;QACxC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YAChB,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEnC,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAEpC,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBAE5B,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI;oBAAE,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC;gBAEnE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;oBAAE,OAAO,KAAK,CAAC;YACxD,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAsB,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC;IAExE;;;;;;;;;;;;OAYG;IACH,SAAgB,UAAU,CAAI,MAAc;QAC1C,IAAI,SAAS,KAAK,MAAM;YAAE,OAAO,cAAc,CAAC;QAEhD,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAJe,aAAU,aAIzB,CAAA;IAED,SAAS,cAAc,CAAC,OAAgB;QACtC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YAChB,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEnC,IAAI,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW;gBAAE,OAAO,KAAK,CAAC;YAEpD,KAAK,MAAM,GAAG,IAAI,EAAE,EAAE,CAAC;gBACrB,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;oBAAE,OAAO,KAAK,CAAC;YACjC,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,EAAE,EAAE,CAAC;gBACrB,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;oBAAE,OAAO,KAAK,CAAC;YACjC,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,EAAE,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;gBACvB,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;gBAEvB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;oBAAE,OAAO,KAAK,CAAC;YAC7C,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAyB,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC;IAEpE;;;;;;;;;;;;;OAaG;IACH,SAAgB,QAAQ,CAAU,OAAe;QAC/C,IAAI,SAAS,KAAK,OAAO;YAAE,OAAO,SAAS,CAAC;QAE5C,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAJe,WAAQ,WAIvB,CAAA;IAED,SAAS,WAAW,CAAC,IAAiC;QACpD,MAAM,MAAM,GAAY,CAAC,EAAE,EAAE,EAAE,EAAW,EAAE;YAC1C,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEnC,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC;YAExB,IAAI,KAAK,KAAK,KAAK;gBAAE,OAAO,KAAK,CAAC;YAElC,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,WAAW,CAAC;gBACjB,KAAK,QAAQ,CAAC;gBACd,KAAK,SAAS,CAAC;gBACf,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC;gBACd,KAAK,UAAU;oBACb,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC3B,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI;wBAAE,OAAO,KAAK,CAAC;oBAE7C,IAAI,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,EAAE,CAAC;wBACtC,OAAO,KAAK,CAAC;oBACf,CAAC;oBAED,IACE,EAAE,YAAY,OAAO;wBACrB,EAAE,YAAY,IAAI;wBAClB,EAAE,YAAY,MAAM;wBACpB,EAAE,YAAY,MAAM,EACpB,CAAC;wBACD,OAAO,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBAC5B,CAAC;oBAED,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;wBACpB,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;4BACnD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gCACvB,OAAO,gBAAgB,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;4BAC9C,CAAC;4BAED,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC1C,CAAC;wBAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;4BACvB,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC5C,CAAC;wBAED,OAAO,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBAC3B,CAAC;oBAED,oDAAoD;oBACpD,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;;;;;;OAeG;IACH,SAAgB,YAAY;QAC1B,OAAO,aAAa,CAAC;IACvB,CAAC;IAFe,eAAY,eAE3B,CAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE9C,MAAM,wBAAwB,GAAY,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACnD,gBAAgB,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,SAAgB,sBAAsB,CACpC,GAAG,IAAiD;QAEpD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,wBAAwB,CAAC;QAEvD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAExC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;IARe,yBAAsB,yBAQrC,CAAA;IAED,MAAM,wBAAwB,GAAe,sBAAsB,CAAC,KAAK,EAAE;QACzE,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,SAAgB,uBAAuB;QACrC,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAFe,0BAAuB,0BAEtC,CAAA;IAED,MAAM,iBAAiB,GAAe,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;QAC/C,MAAM,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC;QAEtB,IAAI,GAAG,KAAK,EAAE,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAEpC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEX,OAAO,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC;YACjB,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;;;;;;;OAUG;IACH,SAAgB,gBAAgB;QAC9B,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAFe,mBAAgB,mBAE/B,CAAA;IAED,MAAM,cAAc,GAAY,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACzC,kBAAkB,CAAC,EAAE,CAAC,KAAK,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAEpD;;;;;;;;;;;OAWG;IACH,SAAgB,aAAa;QAC3B,OAAO,cAAc,CAAC;IACxB,CAAC;IAFe,gBAAa,gBAE5B,CAAA;IAED,MAAM,UAAU,GAAY,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CACrC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAE5C;;;;;;;;;;OAUG;IACH,SAAgB,SAAS;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAFe,YAAS,YAExB,CAAA;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAgB,cAAc,CAC5B,KAAY,SAAS,EAAE;QAEvB,OAAO,CAAC,IAAqB,EAAE,IAAqB,EAAW,EAAE,CAC/D,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IANe,iBAAc,iBAM7B,CAAA;AACH,CAAC,EAragB,EAAE,KAAF,EAAE,QAqalB"}

package/dist/esm/err.d.mts

@@ -1,10 +1,10 @@
 /**
- * Throws an `Err.ForcedError` error when called.
+ * Throws an `ErrBase.ForcedError` error when called.
  * @example
  * ```ts
  * const emptyMap = HashMap.empty<number, string>()
  * emptyMap.get(5, Err);
- * // throws: Err.CustomError(message: 'Err: forced to throw error')
+ * // throws: ErrBase.ForcedError(message: 'Err: Forced to throw error')
  * ```
  */
 export declare function Err(): never;
@@ -17,6 +17,9 @@ export declare namespace ErrBase {
         constructor(message: string);
         get name(): string;
     }
+    /**
+     * Error type that is thrown by `Err` and the functions returned by `ErrBase.msg`.
+     */
     class ForcedError extends CustomError {
     }
     /**
@@ -26,7 +29,7 @@ export declare namespace ErrBase {
      * ```ts
      * const emptyMap = HashMap.empty<number, string>()
      * emptyMap.get(5, ErrBase.msg('not found'));
-     * // throws: Err.CustomError(message: 'not found')
+     * // throws: ErrBase.ForcedError(message: 'not found')
      * ```
      */
     function msg(message: string): () => never;

package/dist/esm/err.mjs

@@ -1,10 +1,10 @@
 /**
- * Throws an `Err.ForcedError` error when called.
+ * Throws an `ErrBase.ForcedError` error when called.
  * @example
  * ```ts
  * const emptyMap = HashMap.empty<number, string>()
  * emptyMap.get(5, Err);
- * // throws: Err.CustomError(message: 'Err: forced to throw error')
+ * // throws: ErrBase.ForcedError(message: 'Err: Forced to throw error')
  * ```
  */
 export function Err() {
@@ -24,6 +24,9 @@ export var ErrBase;
         }
     }
     ErrBase.CustomError = CustomError;
+    /**
+     * Error type that is thrown by `Err` and the functions returned by `ErrBase.msg`.
+     */
     class ForcedError extends CustomError {
     }
     ErrBase.ForcedError = ForcedError;
@@ -34,7 +37,7 @@ export var ErrBase;
      * ```ts
      * const emptyMap = HashMap.empty<number, string>()
      * emptyMap.get(5, ErrBase.msg('not found'));
-     * // throws: Err.CustomError(message: 'not found')
+     * // throws: ErrBase.ForcedError(message: 'not found')
      * ```
      */
     function msg(message) {

package/dist/esm/err.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"err.mjs","sourceRoot":"","sources":["../../src/err.mts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,EAAE,CAAC;AACrD,CAAC;AAED,MAAM,KAAW,OAAO,CA6BvB;AA7BD,WAAiB,OAAO;IACtB;;OAEG;IACH,MAAsB,WAAW;QAC/B,YAAqB,OAAe;YAAf,YAAO,GAAP,OAAO,CAAQ;QAAG,CAAC;QAExC,IAAI,IAAI;YACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAC/B,CAAC;KACF;IANqB,mBAAW,cAMhC,CAAA;IAED,MAAa,WAAY,SAAQ,WAAW;KAAG;IAAlC,mBAAW,cAAuB,CAAA;IAE/C;;;;;;;;;OASG;IACH,SAAgB,GAAG,CAAC,OAAe;QACjC,OAAO;YACL,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;IACJ,CAAC;IAJe,WAAG,MAIlB,CAAA;AACH,CAAC,EA7BgB,OAAO,KAAP,OAAO,QA6BvB"}
+{"version":3,"file":"err.mjs","sourceRoot":"","sources":["../../src/err.mts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,EAAE,CAAC;AACrD,CAAC;AAED,MAAM,KAAW,OAAO,CAgCvB;AAhCD,WAAiB,OAAO;IACtB;;OAEG;IACH,MAAsB,WAAW;QAC/B,YAAqB,OAAe;YAAf,YAAO,GAAP,OAAO,CAAQ;QAAG,CAAC;QAExC,IAAI,IAAI;YACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAC/B,CAAC;KACF;IANqB,mBAAW,cAMhC,CAAA;IAED;;OAEG;IACH,MAAa,WAAY,SAAQ,WAAW;KAAG;IAAlC,mBAAW,cAAuB,CAAA;IAE/C;;;;;;;;;OASG;IACH,SAAgB,GAAG,CAAC,OAAe;QACjC,OAAO;YACL,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;IACJ,CAAC;IAJe,WAAG,MAIlB,CAAA;AACH,CAAC,EAhCgB,OAAO,KAAP,OAAO,QAgCvB"}

package/dist/esm/index.d.mts

@@ -1,6 +1,12 @@
 /**
  * @packageDocumentation
  *
- * The `@rimbu/common` package provides many commonly used types and utilities that can also be of use to Rimbu users.<br/>
+ * The `@rimbu/common` package provides shared equality and comparison helpers, range and index
+ * utilities, lazy and async value helpers, traversal utilities, and rich type‑level helpers used
+ * throughout the Rimbu ecosystem.<br/>
+ * Use it when you need well‑tested primitives like `Eq`, `Comp`, `Range`, `OptLazy`, `AsyncOptLazy`,
+ * or advanced type utilities in your own code, or when building on top of other Rimbu packages.<br/>
+ * See the [Common docs](https://rimbu.org/docs/common/overview) and
+ * [API reference](https://rimbu.org/api/rimbu/common) for more information.
  */
 export * from './internal.mjs';

package/dist/esm/index.mjs

@@ -1,7 +1,13 @@
 /**
  * @packageDocumentation
  *
- * The `@rimbu/common` package provides many commonly used types and utilities that can also be of use to Rimbu users.<br/>
+ * The `@rimbu/common` package provides shared equality and comparison helpers, range and index
+ * utilities, lazy and async value helpers, traversal utilities, and rich type‑level helpers used
+ * throughout the Rimbu ecosystem.<br/>
+ * Use it when you need well‑tested primitives like `Eq`, `Comp`, `Range`, `OptLazy`, `AsyncOptLazy`,
+ * or advanced type utilities in your own code, or when building on top of other Rimbu packages.<br/>
+ * See the [Common docs](https://rimbu.org/docs/common/overview) and
+ * [API reference](https://rimbu.org/api/rimbu/common) for more information.
  */
 export * from './internal.mjs';
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/index.mts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/index.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,cAAc,gBAAgB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/common",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "Common types and objects used in many other Rimbu packages",
   "keywords": [
     "common",
@@ -34,6 +34,7 @@
   "types": "./dist/cjs/index.d.cts",
   "exports": {
     ".": {
+      "bun": "./dist/bun/index.mts",
       "import": {
         "types": "./dist/esm/index.d.mts",
         "default": "./dist/esm/index.mjs"
@@ -41,8 +42,7 @@
       "require": {
         "types": "./dist/cjs/index.d.cts",
         "default": "./dist/cjs/index.cjs"
-      },
-      "bun": "./dist/bun/index.mts"
+      }
     }
   },
   "files": [
@@ -65,7 +65,7 @@
     "bundle:deno-clean": "rimraf _deno_prepare",
     "bundle:esm": "tsc --p tsconfig.esm.json",
     "clean": "rimraf dist",
-    "extract-api": "ts-node ../../config/api-extractor.ts config/api-extractor.main.json",
+    "extract-api": "tsx ../../config/api-extractor.ts config/api-extractor.main.json",
     "format": "yarn format:base --write",
     "format:base": "prettier \"{!CHANGELOG.md}|**/**/*.{ts,tsx,js,mts,mjs,json,md}\"",
     "format:check": "yarn format:base --check",
@@ -82,5 +82,5 @@
   "dependencies": {
     "tslib": "^2.6.2"
   },
-  "gitHead": "b7ed656d2c55d1a715d6a3f52e364e68cb98c759"
+  "gitHead": "1c35dbdd9ce13aeba818b41eb20bab1e826b3e16"
 }

package/src/eq.mts

@@ -4,6 +4,15 @@
 export type Eq<T> = (v1: T, v2: T) => boolean;
 
 export namespace Eq {
+  /**
+   * Converts any given `value` to a string representation that is stable for equality
+   * and ordering comparisons.
+   *
+   * For primitive values and objects with a custom `toString` implementation, it uses
+   * `String(value)`. For plain objects with the default `Object.prototype.toString`
+   * implementation, it uses `JSON.stringify(value)` instead.
+   * @param value - the value to convert
+   */
   export function convertAnyToString(value: any): string {
     if (
       typeof value !== 'object' ||
@@ -146,7 +155,7 @@ export namespace Eq {
   /**
    * Returns an Eq instance that checks equality of objects containing property values of type V by iteratively
    * applying given `valueEq` to each of the object's property values.
-   * @typeparam - the object property value type
+   * @typeparam V - the object property value type
    * @param valueEq - (optional) the Eq instance to use to compare property values
    * @example
    * ```ts
@@ -228,7 +237,7 @@ export namespace Eq {
    * @typeparam T - the value type
    * @example
    * ```ts
-   * const eq = anyFlatEq()
+   * const eq = Eq.anyFlatEq()
    * console.log(eq(1, 'a'))
    * // => false
    * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -246,7 +255,7 @@ export namespace Eq {
    * @typeparam T - the value type
    * @example
    * ```ts
-   * const eq = anyFlatEq()
+   * const eq = Eq.anyShallowEq()
    * console.log(eq(1, 'a'))
    * // => false
    * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -267,7 +276,7 @@ export namespace Eq {
    * @typeparam T - the value type
    * @example
    * ```ts
-   * const eq = anyFlatEq()
+   * const eq = Eq.anyDeepEq()
    * console.log(eq(1, 'a'))
    * // => false
    * console.log(eq({ a: 1, b: 2 }, { b: 2, a: 1 }))
@@ -359,6 +368,18 @@ export namespace Eq {
   const _anyToStringEq: Eq<any> = (v1, v2) =>
     convertAnyToString(v1) === convertAnyToString(v2);
 
+  /**
+   * Returns an Eq instance that considers two values equal when their string
+   * representations, as returned by `Eq.convertAnyToString`, are equal.
+   * @example
+   * ```ts
+   * const eq = Eq.anyToStringEq()
+   * console.log(eq({ a: 1 }, { a: 1 }))
+   * // => true
+   * console.log(eq({ a: 1 }, { a: 2 }))
+   * // => false
+   * ```
+   */
   export function anyToStringEq(): Eq<any> {
     return _anyToStringEq;
   }