Add assert() function for throwing exceptions

Author: pilafmon

.github/workflows/run-spec-on-push.yaml

@@ -11,6 +11,6 @@ jobs:
       w3cHtmlValidator: dry-run  #only run html validation locally
     steps:
       - uses: actions/checkout@v5    #see: https://github.com/actions/checkout/releases
-      - uses: actions/setup-node@v4  #see: https://github.com/actions/setup-node/releases
+      - uses: actions/setup-node@v6  #see: https://github.com/actions/setup-node/releases
       - run: npm install
       - run: npm test

package.json

@@ -65,26 +65,26 @@
       "posttest": "html-validator spec docs"
    },
    "devDependencies": {
-      "@eslint/js": "~9.38",
+      "@eslint/js": "~9.39",
       "@fortawesome/fontawesome-free": "~7.1",
-      "@types/node": "~24.9",
-      "add-dist-header": "~1.5",
+      "@types/node": "~24.10",
+      "add-dist-header": "~1.6",
       "assert-deep-strict-equal": "~1.2",
       "copy-file-util": "~1.3",
       "copy-folder-util": "~1.1",
       "dna-engine": "~3.3",
-      "eslint": "~9.38",
+      "eslint": "~9.39",
       "esm-to-plain-js": "~1.1",
-      "jsdom": "~27.0",
+      "jsdom": "~27.1",
       "jshint": "~2.13",
       "mocha": "~11.7",
       "pretty-print-json": "~3.0",
-      "rimraf": "~6.0",
+      "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
       "typescript": "~5.9",
       "typescript-eslint": "~8.46",
       "uglify-js": "~3.19",
-      "w3c-html-validator": "~1.9",
+      "w3c-html-validator": "~2.0",
       "web-ignition": "~2.4"
    }
 }

spec/package.spec.js

@@ -26,6 +26,33 @@ describe('The "dist" folder', () => {
 
    });
 
+////////////////////////////////////////////////////////////////////////////////
+describe('Library module', () => {
+
+   it('is an object', () => {
+      const actual =   { constructor: clabe.constructor.name };
+      const expected = { constructor: 'Object' };
+      assertDeepStrictEqual(actual, expected);
+      });
+
+   it('has the correct properties', () => {
+      const module = clabe;
+      const actual = Object.keys(module).sort().map(key => [key, typeof module[key]]);
+      const expected = [
+         ['assert',          'function'],
+         ['banksMap',        'object'],
+         ['calculate',       'function'],
+         ['cities',          'object'],
+         ['citiesMap',       'object'],
+         ['computeChecksum', 'function'],
+         ['validate',        'function'],
+         ['version',         'string'],
+         ];
+      assertDeepStrictEqual(actual, expected);
+      });
+
+   });
+
 ////////////////////////////////////////////////////////////////////////////////
 describe('Current number of banks and cities', () => {
 

src/clabe.ts

@@ -29,6 +29,11 @@ const clabe = {
 
    version: '{{package.version}}',
 
+   assert(ok: unknown, message: string | null) {
+      if (!ok)
+         throw new Error(`[clabe-validator] ${message}`);
+      },
+
    computeChecksum(clabeNum17: string): number | null {
       // Returns the checksum calculated from the first 17 characters of CLABE number.
       // Example:
@@ -50,8 +55,7 @@ const clabe = {
          bank:       'Invalid bank code: ',
          city:       'Invalid city code: ',
          };
-      if (typeof clabeNum !== 'string')
-         throw new Error('clabe.validator.check(clabeNum) -- Expected string, got: ' + typeof clabeNum);
+      clabe.assert(typeof clabeNum === 'string', 'Expected string, got: ' + typeof clabeNum);
       const bankCode = clabeNum.substring(0, 3);
       const cityCode = clabeNum.substring(3, 6);
       const account =  clabeNum.substring(6, 17);