better-lock 2.0.1-beta → 2.0.2-beta

package/.idea/markdown.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MarkdownSettings">
+    <enabledExtensions>
+      <entry key="MermaidLanguageExtension" value="false" />
+      <entry key="PlantUMLLanguageExtension" value="false" />
+    </enabledExtensions>
+  </component>
+</project>

package/README.md

@@ -22,6 +22,8 @@ A (better) node.js lock library.
 
 ```bash
 npm install --save better-lock
+# or
+yarn add better-lock
 ```
 
 ### Usage examples
@@ -186,8 +188,6 @@ Most commonly used options are:
 - `queue_size`  
   Max queue size for waiting jobs.
 
-Options are presented using `snake_case`, but you can also provide them using `camelCase` keys, if that better suits your code style (eg. `extend_stack_traces` becomes `extendStackTraces`).
-
 Default options are a static member `DEFAULT_OPTIONS` on the `BetterLock` class. That can be seen [here](src/better_lock.ts). During runtime, you can change the defaults like this:
 
 ```javascript
@@ -196,53 +196,53 @@ import BetterLock from 'better-lock';
 BetterLock.DEFAULT_OPTIONS.wait_timeout = 1000;
 ```
 
-### Motivation
+### When to use
 
-I needed something like [async-lock](https://github.com/rogierschouten/async-lock), but a bit easier to debug.
+This library is a good fit if:
 
-This library improves upon `async-lock` in following ways:
+- You need a local lock in your node.js application.
+- You have some advanced needs, like multiple keys per lock, timeouts, aborting...
+- You like good error messages, with full stack traces.
+- You like good types, either through typescript or JSDoc comments
 
-- Good error messages and log facility
-- Added features (execution timeout, abort jobs...)
-- Extended stack traces (so when you get an error, you have a full stack trace of the original calling code)
-- JSDoc comments (helps if you're using an IDE)
+The library is not a good fit if:
 
-Following features are present in both libraries:
+- **You need lock reentrancy.**  
+  There is no good solution for this in node.js that I know of. And this library doesn't offer any.
 
-- Multiple keys per lock instance
-- Acquire multiple keys in a single call
-- Interface, with executor and the callback function
-- Promises
-- Timeout and queue limit
+- **You need a shared lock between different nodes**  
+  This library is a single process only. If you need to coordinate multiple apps or services, you need a different library.
 
-Following features are present in `async-lock`, but not here:
+### Change log
 
-- Domain reentrancy (domains are going away)
+#### **2.0.0** (_2021/05/30_)
 
-**NOTE:** If you want to sync multiple node instances doing the same operation, this library will not help you. You need something that works over network and can use a shared arbiter of who gets the lock (eg. redis).
+Major update. The entire library was rewritten in typescript, so you should now get typings in most editors. We also had to switch tests from mocha + chai to jest (easier ts integration).
 
-### Change log
+The API and features have remained largely the same, just a bit of a refresh.
 
-#### **0.1.1** (_2018/06/04_)
+Non-breaking and internal changes:
 
-You can now use a Number as job name
+- We now export all error names as a type script type. A few other types as well.
+- Errors now have `name` parameter, which matches these names.
 
-#### **0.2.0** (_2018/09/27_)
+Breaking changes:
 
-Code reformat, better pattern for loading options. No feature upgrades.
+- You can no longer use camel case versions of external-facing objects. Eg. you can no longer pass `waitTimeout` instead of `wait_timeout`. In retrospect, this was a pretty flaky API to maintain.
 
-#### **0.2.1** (_2018/09/27_)
+- Internal `LockJob` class is no longer exported.
 
-- Better and customizable Promise detection.
-- Restored DEFAULT_OPTIONS.
+- Also, errors no longer expose internal `LockJob` instances (`err.job`). We now instead provide the most important fields from the job (`id` and `keys`).
 
-#### **0.3.0** (_2018/10/01_)
+- Error names have been renamed to have `BetterLock` prefix. Eg. `WaitTimeoutError` -> `BetterLockWaitTimeoutError`. This will influence `err.name` and `err.message` parameters. The idea here is, if you see `BetterLock` error in the wild, you will know what generated it.
 
-Can abort jobs waiting in queue.
+- We have renamed `BetterLock.BetterLockError` to `BetterLock.BaseError` and `BetterLock.BetterLockInternalError` to `BetterLock.InternalError` to better match the naming scheme.
 
-#### **0.3.1** (_2018/10/01_)
+- Since Options are no longer a class but interface, we are no longer exporting them under `BetterLock.Options`. You can do `import {BetterLockOptions} from 'better-lock';` to get the typescript type.
 
-Updated CI to use the current node versions (0.8 & 0.10). Older node versions should continue to work, but are no longer tested. Also, README updates.
+#### **1.0.1** (_2019/01/28_)
+
+Handle empty key list
 
 #### **1.0.0** (_2019/01/28_)
 
@@ -251,34 +251,26 @@ Major version bump.
 - Added multi-key locks and refactored a bunch of internals.
 - Removed `OVERFLOW_STRATEGIES` and related options, which is mostly the reason for the major version bump. The library should otherwise work the same.
 
-#### **1.0.1** (_2019/01/28_)
-
-Handle empty key list
-
-#### **2.0.0** (_2021/05/30_)
-
-Major update. The entire library was rewritten in typescript, so you should now get typings in most editors. We also had to switch tests from mocha + chai to jest (easier ts integration).
-
-The API and features have remained largely the same, just a bit of a refresh.
+#### **0.3.1** (_2018/10/01_)
 
-Non-breaking and internal changes:
+Updated CI to use the current node versions (0.8 & 0.10). Older node versions should continue to work, but are no longer tested. Also, README updates.
 
-- We now export all error names as a type script type. A few other types as well.
-- Errors now have `name` parameter, which matches these names.
+#### **0.3.0** (_2018/10/01_)
 
-Breaking changes:
+Can abort jobs waiting in queue.
 
-- You can no longer use camel case versions of external-facing objects. Eg. you can no longer pass `waitTimeout` instead of `wait_timeout`. In retrospect, this was a pretty flaky API to maintain.
+#### **0.2.1** (_2018/09/27_)
 
-- Internal `LockJob` class is no longer exported.
+- Better and customizable Promise detection.
+- Restored DEFAULT_OPTIONS.
 
-- Also, errors no longer expose internal `LockJob` instances (`err.job`). We now instead provide the most important fields from the job (`id` and `keys`).
+#### **0.2.0** (_2018/09/27_)
 
-- Error names have been renamed to have `BetterLock` prefix. Eg. `WaitTimeoutError` -> `BetterLockWaitTimeoutError`. This will influence `err.name` and `err.message` parameters. The idea here is, if you see `BetterLock` error in the wild, you will know what generated it.
+Code reformat, better pattern for loading options. No feature upgrades.
 
-- We have renamed `BetterLock.BetterLockError` to `BetterLock.BaseError` and `BetterLock.BetterLockInternalError` to `BetterLock.InternalError` to better match the naming scheme.
+#### **0.1.1** (_2018/06/04_)
 
-- Since Options are no longer a class but interface, we are no longer exporting them under `BetterLock.Options`. You can do `import {BetterLockOptions} from 'better-lock';` to get the typescript type.
+You can now use a Number as job name
 
 ### Development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "better-lock",
-  "version": "2.0.1-beta",
+  "version": "2.0.2-beta",
   "description": "A (better) node.js lock library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,16 +26,16 @@
     "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",
     "typescript": "^4.3.2"
   },
   "author": "Ivan Pantic",
@@ -52,5 +52,6 @@
     ".js, .jsx": {
       "style": "module"
     }
-  }
+  },
+  "dependencies": {}
 }