better-lock 2.0.0-beta → 2.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "better-lock",
-  "version": "2.0.0-beta",
+  "version": "2.0.3",
   "description": "A (better) node.js lock library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,8 @@
     "test": "jest",
     "watch": "jest --watchAll",
     "lint": "eslint ./src",
-    "coverage": "jest --coverage"
+    "coverage": "jest --coverage",
+    "docs": "typedoc src/index.ts --excludePrivate --excludeProtected --excludeExternals"
   },
   "repository": {
     "type": "git",
@@ -26,16 +27,18 @@
     "sync"
   ],
   "devDependencies": {
-    "@types/jest": "^26.0.23",
+    "@types/jest": "^27.5.1",
     "@typescript-eslint/eslint-plugin": "^4.25.0",
     "@typescript-eslint/parser": "^4.25.0",
     "eslint": "^7.27.0",
     "eslint-config-prettier": "^8.3.0",
     "import-sort-style-module": "^6.0.0",
-    "jest": "^27.0.2",
+    "jest": "^28.1.0",
     "prettier": "latest",
     "prettier-plugin-import-sort": "0.0.7",
-    "ts-jest": "^27.0.1",
+    "ts-jest": "^28.0.3",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-missing-exports": "^0.22.6",
     "typescript": "^4.3.2"
   },
   "author": "Ivan Pantic",
@@ -52,5 +55,6 @@
     ".js, .jsx": {
       "style": "module"
     }
-  }
+  },
+  "dependencies": {}
 }

package/src/better_lock.ts

@@ -12,7 +12,7 @@ import * as tools from './tools';
 import { ICallback, ICallbackExecutor, ILockKey, IPromiseExecutor } from './types';
 
 /**
- * Create a better lock object.
+ * Main better lock class.
  */
 export class BetterLock {
   /**
@@ -23,10 +23,13 @@ export class BetterLock {
     promise_tester: p => p && typeof p.then === 'function',
   };
 
-  private options: IOptions;
-  private log: (msg: string) => void;
-  private queues: { [key: string]: KeyQueue };
+  private readonly options: IOptions;
+  private readonly log: (msg: string) => void;
+  private readonly queues: { [key: string]: KeyQueue };
 
+  /**
+   * Create a better lock instance
+   */
   constructor(options?: IOptions) {
     this.options = tools.assign({}, [BetterLock.DEFAULT_OPTIONS, options]);
     this.log = tools.makeLog(this.options.name, this.options.log);

package/src/errors.ts

@@ -1,4 +1,4 @@
-import { LockJob } from './internals';
+import { KeyQueue, LockJob } from './internals';
 import { IErrorName } from './types';
 
 export class BetterLockError extends Error {
@@ -99,7 +99,8 @@ export class BetterLockQueueOverflowError extends BetterLockError {
   public kicked_out_job_id: number;
 
   constructor(lockName, key, count, job: LockJob<any>) {
-    const message = `Too many jobs (${count}) waiting for ${key}. The most recent job (${job}) was kicked out`;
+    const keyDesignation = key === KeyQueue.DEFAULT_QUEUE_KEY ? '' : ` for key "${key}"`;
+    const message = `Too many jobs (${count}) are waiting${keyDesignation}. The most recent job (${job}) was kicked out`;
 
     super(lockName, message, job.incoming_stack);