@ayapapa-npm/contracts-js 0.4.1 → 0.4.3

package/README.md

@@ -5,11 +5,18 @@
 ![Lines](https://raw.githubusercontent.com/ayapapa/contracts-js/main/badges/coverage-lines.svg)
 ![Statements](https://raw.githubusercontent.com/ayapapa/contracts-js/main/badges/coverage-statements.svg)
 
+## Table of contents
+[Overview](#overview) | [API Reference](#api-reference) | [Installation](#installation) | [Contract Types](#contract-types) | [Usage](#usage)
+
 # contracts-js
+## Overview
 A lightweight Design by Contract library for JavaScript.</br>
 Provides runtime contract checks based on Design by Contract principles.</br>
 All check functions return the evaluated condition itself, so they can be used directly in control flow when exception throwing is suppressed.
 
+## API Reference
+[API document](https://github.com/ayapapa/contracts-js/blob/main/docs/api.md)<br>
+Implementation examples are also included.
 
 ## Installation
 
@@ -132,9 +139,6 @@ Contracts.INVARIANT(
 );
 ```
 
-## API Reference
-[API document](docs/api.md)
-
 ## Usage
 
 ```javascript

package/dist/index.cjs

@@ -30,7 +30,11 @@ var Contracts = class _Contracts {
   /** 
    * Static fields
    */
-  /** Debug mode state */
+  /** 
+   * Debug mode state.<br>
+   * **Note: This property is retained for backward compatibility.<br>
+   * Please use `setConfig()` to change the debug mode.**
+   */
   static DEBUG_MODE = false;
   /** default configuration */
   static #defaultConf = {
@@ -39,8 +43,6 @@ var Contracts = class _Contracts {
   };
   /** Current config. */
   static #config = { ..._Contracts.#defaultConf };
-  /** logger */
-  //private static logger: LogProvider = console;
   /**
    * Configures contract checking behavior.
    *
@@ -61,7 +63,7 @@ var Contracts = class _Contracts {
    * it is used instead of the standard logger, `console`.
    * This module uses only the `error` method of the `logger`. <br>
    * <br>
-   * Note: If the value of a property is `undefined`, it is treated as unspecified.
+   * Note: If the value of a property is `undefined` or `null`, it is treated as unspecified.
    * 
    * @param reset
    * If `true`, unspecified values ​​are saved to the settings as default values. <br>
@@ -171,9 +173,9 @@ var Contracts = class _Contracts {
    * Verifies an intermediate condition in debug mode only.
    *
    * Performs the same validation as VERIFY only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -290,9 +292,9 @@ var Contracts = class _Contracts {
    * Checks a precondition in debug mode only.
    *
    * Performs the same validation as REQUIRE only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -412,9 +414,9 @@ var Contracts = class _Contracts {
    * Checks a postcondition in debug mode only.
    *
    * Performs the same validation as ENSURE only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -531,9 +533,9 @@ var Contracts = class _Contracts {
    * Checks an invariant condition in debug mode only.
    *
    * Performs the same validation as INVARIANT only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -631,9 +633,6 @@ var Contracts = class _Contracts {
   static check(isOk, prefix = "CHECK", ngMsg = "", ErrorClass = Error, eParams, eProps) {
     if (eProps === void 0) {
       eProps = eParams ?? {};
-      eParams = null;
-    } else {
-      eProps ??= {};
     }
     if (!isOk) {
       const msg = `[${prefix}] ${ngMsg ?? ""}`;
@@ -643,7 +642,7 @@ var Contracts = class _Contracts {
         throw err;
       }
       if (ngMsg) {
-        _Contracts.getLogger().error(msg, eProps);
+        _Contracts.#getLogger().error(msg, eProps);
       }
     }
     return isOk;
@@ -651,10 +650,9 @@ var Contracts = class _Contracts {
   /**
    * Debug-only contract evaluation logic.
    *
-   * Executes contract validation only when DEBUG_MODE
-   * is enabled.
+   * Executes contract validation only when `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * this method returns the original condition value
    * without performing any validation.
    *
@@ -701,11 +699,10 @@ var Contracts = class _Contracts {
     ) : isOk;
   }
   /** 
-   * Get logger 
-   *
    * @internal
+   * Get logger 
    */
-  static getLogger() {
+  static #getLogger() {
     return _Contracts.#config.logger;
   }
 };

package/dist/index.d.cts

@@ -8,7 +8,7 @@ type LogProvider = Pick<Console, 'error'>;
 interface Config {
     /**
      * Debug mode state.
-     * If `true`, `DEBUG_MODE` is enabled; otherwise, it is disabled.
+     * If `true`, `debug_mode`(internal state) is enabled; otherwise, it is disabled.
      * The default is `false`.
      */
     debug?: boolean;
@@ -49,9 +49,9 @@ type ConfigKey = keyof Config;
  * ## Debug Mode
  *
  * Methods ending with `_DEBUG` execute contract checks only
- * when `DEBUG_MODE` is enabled.
+ * when `debug_mode`(internal state) is enabled.
  *
- * When `DEBUG_MODE` is disabled,
+ * When `debug_mode`(internal state) is disabled,
  * these methods return the original condition value
  * without performing validation.
  *
@@ -62,9 +62,12 @@ declare class Contracts {
     /**
      * Static fields
      */
-    /** Debug mode state */
+    /**
+     * Debug mode state.<br>
+     * **Note: This property is retained for backward compatibility.<br>
+     * Please use `setConfig()` to change the debug mode.**
+     */
     static DEBUG_MODE: boolean;
-    /** logger */
     /**
      * Configures contract checking behavior.
      *
@@ -85,7 +88,7 @@ declare class Contracts {
      * it is used instead of the standard logger, `console`.
      * This module uses only the `error` method of the `logger`. <br>
      * <br>
-     * Note: If the value of a property is `undefined`, it is treated as unspecified.
+     * Note: If the value of a property is `undefined` or `null`, it is treated as unspecified.
      *
      * @param reset
      * If `true`, unspecified values ​​are saved to the settings as default values. <br>
@@ -166,18 +169,14 @@ declare class Contracts {
      *   'Calculation result must not be negative'
      * );
      */
-    static VERIFY(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static VERIFY(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Verifies an intermediate condition in debug mode only.
      *
      * Performs the same validation as VERIFY only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -216,11 +215,7 @@ declare class Contracts {
      *   'Intermediate value must not be null'
      * );
      */
-    static VERIFY_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static VERIFY_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a precondition before execution.
      *
@@ -275,18 +270,14 @@ declare class Contracts {
      *   return a / b;
      * }
      */
-    static REQUIRE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static REQUIRE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a precondition in debug mode only.
      *
      * Performs the same validation as REQUIRE only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -325,11 +316,7 @@ declare class Contracts {
      *   'User must exist during debugging'
      * );
      */
-    static REQUIRE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static REQUIRE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a postcondition after execution.
      *
@@ -387,18 +374,14 @@ declare class Contracts {
      *   return result;
      * }
      */
-    static ENSURE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static ENSURE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a postcondition in debug mode only.
      *
      * Performs the same validation as ENSURE only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -437,11 +420,7 @@ declare class Contracts {
      *   'Result should exist during debugging'
      * );
      */
-    static ENSURE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static ENSURE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks an invariant condition.
      *
@@ -496,18 +475,14 @@ declare class Contracts {
      *
      * }
      */
-    static INVARIANT(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static INVARIANT(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks an invariant condition in debug mode only.
      *
      * Performs the same validation as INVARIANT only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -546,11 +521,7 @@ declare class Contracts {
      *   'Cache size exceeded expected limit'
      * );
      */
-    static INVARIANT_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static INVARIANT_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Core contract evaluation logic.
      *
@@ -601,10 +572,9 @@ declare class Contracts {
     /**
      * Debug-only contract evaluation logic.
      *
-     * Executes contract validation only when DEBUG_MODE
-     * is enabled.
+     * Executes contract validation only when `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * this method returns the original condition value
      * without performing any validation.
      *
@@ -641,12 +611,6 @@ declare class Contracts {
      *
      */
     private static checkDebug;
-    /**
-     * Get logger
-     *
-     * @internal
-     */
-    private static getLogger;
 }
 
 export { type Config, type ConfigKey, Contracts, type LogProvider, Contracts as default };

package/dist/index.d.ts

@@ -8,7 +8,7 @@ type LogProvider = Pick<Console, 'error'>;
 interface Config {
     /**
      * Debug mode state.
-     * If `true`, `DEBUG_MODE` is enabled; otherwise, it is disabled.
+     * If `true`, `debug_mode`(internal state) is enabled; otherwise, it is disabled.
      * The default is `false`.
      */
     debug?: boolean;
@@ -49,9 +49,9 @@ type ConfigKey = keyof Config;
  * ## Debug Mode
  *
  * Methods ending with `_DEBUG` execute contract checks only
- * when `DEBUG_MODE` is enabled.
+ * when `debug_mode`(internal state) is enabled.
  *
- * When `DEBUG_MODE` is disabled,
+ * When `debug_mode`(internal state) is disabled,
  * these methods return the original condition value
  * without performing validation.
  *
@@ -62,9 +62,12 @@ declare class Contracts {
     /**
      * Static fields
      */
-    /** Debug mode state */
+    /**
+     * Debug mode state.<br>
+     * **Note: This property is retained for backward compatibility.<br>
+     * Please use `setConfig()` to change the debug mode.**
+     */
     static DEBUG_MODE: boolean;
-    /** logger */
     /**
      * Configures contract checking behavior.
      *
@@ -85,7 +88,7 @@ declare class Contracts {
      * it is used instead of the standard logger, `console`.
      * This module uses only the `error` method of the `logger`. <br>
      * <br>
-     * Note: If the value of a property is `undefined`, it is treated as unspecified.
+     * Note: If the value of a property is `undefined` or `null`, it is treated as unspecified.
      *
      * @param reset
      * If `true`, unspecified values ​​are saved to the settings as default values. <br>
@@ -166,18 +169,14 @@ declare class Contracts {
      *   'Calculation result must not be negative'
      * );
      */
-    static VERIFY(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static VERIFY(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Verifies an intermediate condition in debug mode only.
      *
      * Performs the same validation as VERIFY only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -216,11 +215,7 @@ declare class Contracts {
      *   'Intermediate value must not be null'
      * );
      */
-    static VERIFY_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static VERIFY_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a precondition before execution.
      *
@@ -275,18 +270,14 @@ declare class Contracts {
      *   return a / b;
      * }
      */
-    static REQUIRE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static REQUIRE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a precondition in debug mode only.
      *
      * Performs the same validation as REQUIRE only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -325,11 +316,7 @@ declare class Contracts {
      *   'User must exist during debugging'
      * );
      */
-    static REQUIRE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static REQUIRE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a postcondition after execution.
      *
@@ -387,18 +374,14 @@ declare class Contracts {
      *   return result;
      * }
      */
-    static ENSURE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static ENSURE(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks a postcondition in debug mode only.
      *
      * Performs the same validation as ENSURE only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -437,11 +420,7 @@ declare class Contracts {
      *   'Result should exist during debugging'
      * );
      */
-    static ENSURE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static ENSURE_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks an invariant condition.
      *
@@ -496,18 +475,14 @@ declare class Contracts {
      *
      * }
      */
-    static INVARIANT(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static INVARIANT(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Checks an invariant condition in debug mode only.
      *
      * Performs the same validation as INVARIANT only when
-     * DEBUG_MODE is enabled.
+     * `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * no validation is performed.
      *
      * Typical usage:
@@ -546,11 +521,7 @@ declare class Contracts {
      *   'Cache size exceeded expected limit'
      * );
      */
-    static INVARIANT_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: {
-        [key: string]: any;
-    } | null, eProps?: {
-        [key: string]: any;
-    } | null): boolean;
+    static INVARIANT_DEBUG(isOk: boolean, ngMsg: string | null, ErrorClass?: (new (...args: any[]) => Error) | null, eParams?: Record<string, unknown> | null, eProps?: Record<string, unknown> | null): boolean;
     /**
      * Core contract evaluation logic.
      *
@@ -601,10 +572,9 @@ declare class Contracts {
     /**
      * Debug-only contract evaluation logic.
      *
-     * Executes contract validation only when DEBUG_MODE
-     * is enabled.
+     * Executes contract validation only when `debug_mode`(internal state) is enabled.
      *
-     * When DEBUG_MODE is disabled,
+     * When `debug_mode`(internal state) is disabled,
      * this method returns the original condition value
      * without performing any validation.
      *
@@ -641,12 +611,6 @@ declare class Contracts {
      *
      */
     private static checkDebug;
-    /**
-     * Get logger
-     *
-     * @internal
-     */
-    private static getLogger;
 }
 
 export { type Config, type ConfigKey, Contracts, type LogProvider, Contracts as default };

package/dist/index.js

@@ -3,7 +3,11 @@ var Contracts = class _Contracts {
   /** 
    * Static fields
    */
-  /** Debug mode state */
+  /** 
+   * Debug mode state.<br>
+   * **Note: This property is retained for backward compatibility.<br>
+   * Please use `setConfig()` to change the debug mode.**
+   */
   static DEBUG_MODE = false;
   /** default configuration */
   static #defaultConf = {
@@ -12,8 +16,6 @@ var Contracts = class _Contracts {
   };
   /** Current config. */
   static #config = { ..._Contracts.#defaultConf };
-  /** logger */
-  //private static logger: LogProvider = console;
   /**
    * Configures contract checking behavior.
    *
@@ -34,7 +36,7 @@ var Contracts = class _Contracts {
    * it is used instead of the standard logger, `console`.
    * This module uses only the `error` method of the `logger`. <br>
    * <br>
-   * Note: If the value of a property is `undefined`, it is treated as unspecified.
+   * Note: If the value of a property is `undefined` or `null`, it is treated as unspecified.
    * 
    * @param reset
    * If `true`, unspecified values ​​are saved to the settings as default values. <br>
@@ -144,9 +146,9 @@ var Contracts = class _Contracts {
    * Verifies an intermediate condition in debug mode only.
    *
    * Performs the same validation as VERIFY only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -263,9 +265,9 @@ var Contracts = class _Contracts {
    * Checks a precondition in debug mode only.
    *
    * Performs the same validation as REQUIRE only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -385,9 +387,9 @@ var Contracts = class _Contracts {
    * Checks a postcondition in debug mode only.
    *
    * Performs the same validation as ENSURE only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -504,9 +506,9 @@ var Contracts = class _Contracts {
    * Checks an invariant condition in debug mode only.
    *
    * Performs the same validation as INVARIANT only when
-   * DEBUG_MODE is enabled.
+   * `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * no validation is performed.
    *
    * Typical usage:
@@ -604,9 +606,6 @@ var Contracts = class _Contracts {
   static check(isOk, prefix = "CHECK", ngMsg = "", ErrorClass = Error, eParams, eProps) {
     if (eProps === void 0) {
       eProps = eParams ?? {};
-      eParams = null;
-    } else {
-      eProps ??= {};
     }
     if (!isOk) {
       const msg = `[${prefix}] ${ngMsg ?? ""}`;
@@ -616,7 +615,7 @@ var Contracts = class _Contracts {
         throw err;
       }
       if (ngMsg) {
-        _Contracts.getLogger().error(msg, eProps);
+        _Contracts.#getLogger().error(msg, eProps);
       }
     }
     return isOk;
@@ -624,10 +623,9 @@ var Contracts = class _Contracts {
   /**
    * Debug-only contract evaluation logic.
    *
-   * Executes contract validation only when DEBUG_MODE
-   * is enabled.
+   * Executes contract validation only when `debug_mode`(internal state) is enabled.
    *
-   * When DEBUG_MODE is disabled,
+   * When `debug_mode`(internal state) is disabled,
    * this method returns the original condition value
    * without performing any validation.
    *
@@ -674,11 +672,10 @@ var Contracts = class _Contracts {
     ) : isOk;
   }
   /** 
-   * Get logger 
-   *
    * @internal
+   * Get logger 
    */
-  static getLogger() {
+  static #getLogger() {
     return _Contracts.#config.logger;
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ayapapa-npm/contracts-js",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "A lightweight Design by Contract library for JavaScript.",
   "license": "MIT",
   "author": "ayapapa",
@@ -18,6 +18,7 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --out-dir dist --clean --dts",
+    "build:doc": "npx typedoc && node scripts/rename-docs.cjs",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
     "test:debug": "vitest --inspect-brk --run",
@@ -25,9 +26,8 @@
     "test:ui": "vitest --ui",
     "coverage": "vitest run --coverage",
     "coverage:ui": "vitest run --coverage && start coverage/index.html",
-    "check": "npm run typecheck && npm run build && npm run test",
-    "release:check": "npm run check",
-    "prepublishOnly": "npm run release:check"
+    "check": "npm run typecheck && npm run build && npm run build:doc && npm run coverage:ui",
+    "prepublishOnly": "npm run check"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",