@rimbu/common 2.0.1 → 2.0.3

package/src/err.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 function Err(): never {
@@ -18,11 +18,14 @@ export namespace ErrBase {
   export abstract class CustomError {
     constructor(readonly message: string) {}
 
-    get name() {
+    get name(): string {
       return this.constructor.name;
     }
   }
 
+  /**
+   * Error type that is thrown by `Err` and the functions returned by `ErrBase.msg`.
+   */
   export class ForcedError extends CustomError {}
 
   /**
@@ -32,7 +35,7 @@ export 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')
    * ```
    */
   export function msg(message: string): () => never {

package/src/index.mts

@@ -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';