cross-process-lock 2.0.1 → 2.1.0

package/README.md

@@ -1,23 +1,22 @@
 # cross-process-lock
 
+![Downloads](https://img.shields.io/npm/dw/cross-process-lock?style=flat-square)
+![Version@npm](https://img.shields.io/npm/v/cross-process-lock?label=version%40npm&style=flat-square)
+![Version@git](https://img.shields.io/github/package-json/v/szikszail/cross-process-lock/master?label=version%40git&style=flat-square)
+
 Cross-process file locking solution with lock-queue
 
 ## Usage
 
 ``` javascript
-const {
-    lock
-} = require('cross-process-lock');
-const {
-    writeFileSync
-} = require('fs');
+const { lock } = require('cross-process-lock');
+const { writeFileSync } = require('fs');
 // create a lock for the given file
-lock('file.txt').then(unlock => {
-    // do smth with the file here
-    writeFileSync('file.txt', 'some content', 'utf8');
-    // unlock file with the received function
-    return unlock();
-});
+const unlock = await lock('file.txt')
+// do smth with the file here
+writeFileSync('file.txt', 'some content', 'utf8');
+// unlock file with the received function
+return unlock();
 ```
 
 ## API
@@ -28,8 +27,8 @@ lock('file.txt').then(unlock => {
 
 **Arguments**:
 
-* `{string} file` - path of the file needs to be locked
-* `{lockOptions} options` - options to use to lock file, e.g timeouts
+* `{string} file` - the path of the file needs to be locked
+* `{lockOptions} options` - the options to use to lock file, e.g timeouts
 
 **Returns**: `Promise<Function>` - resolved with `unlock` function in case of successful lock; rejected in case of file couldn't be lock in the given timeout
 
@@ -39,16 +38,27 @@ lock('file.txt').then(unlock => {
 
 **Arguments**:
 
-* `{string} file` - path of the file needs to be unlocked
+* `{string} file` - the path of the file needs to be unlocked
 
 **Returns**: `Promise` - resolved in case of successful unlock or rejected in case of any error
 
+### WithLock
+
+`withLock(file[, options], callback)` - executes the callback with locking before and unlocking after the execution
+
+**Arguments**:
+* `{string} file` - path of the file needs to be locked
+* `{lockOptions} options` - the options to use to lock file, e.g timeouts
+* `{() => Promise<T>} callback` - the function to be executed
+
+**Returns**: `Promise<T>` - resolved/rejected with the result of the callback
+
 ### lockOptions
 
-| Option | Description | Default |
-|:-------|:------------|:-------:|
+| Option                 | Description                                    |  Default   |
+| :--------------------- | :--------------------------------------------- | :--------: |
 | `lockTimeout {number}` | timeout (ms) when locks automatically released | 20 minutes |
-| `waitTimeout {number}` | timeout (ms) until lock waits to lock a file | 10 seconds |
+| `waitTimeout {number}` | timeout (ms) until lock waits to lock a file   | 10 seconds |
 
 ## Debug
 

package/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./lock";
 export * from "./unlock";
+export * from "./with";

package/index.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./lock"), exports);
 tslib_1.__exportStar(require("./unlock"), exports);
+tslib_1.__exportStar(require("./with"), exports);
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,mDAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,mDAAyB;AACzB,iDAAuB"}

package/lock.d.ts

@@ -1,9 +1,18 @@
-import { UnlockFunction } from "./unlock";
 export interface LockOptions {
     lockTimeout?: number;
     waitTimeout?: number;
 }
-export declare type LockFunction = (file: string, options?: LockOptions) => Promise<UnlockFunction>;
 export declare class LockError extends Error {
 }
-export declare const lock: LockFunction;
+export type UnlockFunction = (file?: string) => Promise<void>;
+/**
+ * Creates a cross-process lock for the given file, for the actual process.
+ *
+ * Note, that it will be only a soft-lock, the file will be locked for other
+ * instances of cross-process-lock, or processes using the same API for locking.
+ *
+ * @param file The path of the file to lock.
+ * @param options The lock options/timeout.
+ * @returns The function to unlock the file.
+ */
+export declare function lock(file: string, options?: LockOptions): Promise<UnlockFunction>;

package/lock.js

@@ -14,52 +14,64 @@ const INTERVAL = 500;
 class LockError extends Error {
 }
 exports.LockError = LockError;
-const lock = (file, options = {}) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    options = Object.assign(Object.assign({}, DEFAULT_OPTIONS), options);
-    logger_1.logger("lock file:%s", file);
-    logger_1.logger("lock options:%o", options);
-    if (!fs_1.existsSync(file)) {
-        logger_1.logger("lock file does not exist");
-        throw new Error(`The given file (${file}) does not exist!`);
-    }
-    const lockTime = Date.now();
-    const lockFile = `${file}.lock`;
-    const tryToLock = () => new Promise((resolve, reject) => {
-        const now = Date.now();
-        logger_1.logger("lock now:%d", now);
-        if (now - lockTime >= options.waitTimeout) {
-            logger_1.logger("lock too many tries");
-            return reject(new LockError(`Couldn't lock file (${file}) in the given timeout (${options.waitTimeout} ms)!`));
+/**
+ * Creates a cross-process lock for the given file, for the actual process.
+ *
+ * Note, that it will be only a soft-lock, the file will be locked for other
+ * instances of cross-process-lock, or processes using the same API for locking.
+ *
+ * @param file The path of the file to lock.
+ * @param options The lock options/timeout.
+ * @returns The function to unlock the file.
+ */
+function lock(file, options = {}) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        options = Object.assign(Object.assign({}, DEFAULT_OPTIONS), options);
+        (0, logger_1.logger)("lock file:%s", file);
+        (0, logger_1.logger)("lock options:%o", options);
+        if (!(0, fs_1.existsSync)(file)) {
+            (0, logger_1.logger)("lock file does not exist");
+            throw new Error(`The given file (${file}) does not exist!`);
         }
-        const done = () => resolve(unlock_1.unlock.bind(null, file));
-        const next = () => {
-            logger_1.logger("lock schedule");
-            setTimeout(() => {
-                logger_1.logger("lock schedule called");
-                tryToLock().then(done, reject);
-            }, INTERVAL);
-        };
-        let def = Promise.resolve(null);
-        if (fs_1.existsSync(lockFile)) {
-            logger_1.logger("lock read metadata");
-            def = metadata_1.readMetadata(lockFile);
-        }
-        def.then((metadata) => {
-            const actual = Date.now();
-            const lockedTime = metadata ? actual - metadata.lockTime : -1;
-            logger_1.logger("lock metadata:%o", metadata);
-            logger_1.logger("lock actual:%d lockedTime:%d", actual, lockedTime);
-            if (!metadata || metadata.pID === process.pid || lockedTime > options.lockTimeout) {
-                logger_1.logger("lock locking");
-                metadata_1.saveMetadata(lockFile, lockTime).then(done, next);
+        const lockTime = Date.now();
+        const lockFile = `${file}.lock`;
+        const tryToLock = () => new Promise((resolve, reject) => {
+            const now = Date.now();
+            (0, logger_1.logger)("lock now:%d", now);
+            if (now - lockTime >= options.waitTimeout) {
+                (0, logger_1.logger)("lock too many tries");
+                return reject(new LockError(`Couldn't lock file (${file}) in the given timeout (${options.waitTimeout} ms)!`));
             }
-            else {
-                logger_1.logger("lock next iteration");
-                next();
+            const done = () => resolve(unlock_1.unlock.bind(null, file));
+            const next = () => {
+                (0, logger_1.logger)("lock schedule");
+                setTimeout(() => {
+                    (0, logger_1.logger)("lock schedule called");
+                    tryToLock().then(done, reject);
+                }, INTERVAL);
+            };
+            let def = Promise.resolve(null);
+            if ((0, fs_1.existsSync)(lockFile)) {
+                (0, logger_1.logger)("lock read metadata");
+                def = (0, metadata_1.readMetadata)(lockFile);
             }
-        }, next);
+            def.then((metadata) => {
+                const actual = Date.now();
+                const lockedTime = metadata ? actual - metadata.lockTime : -1;
+                (0, logger_1.logger)("lock metadata:%o", metadata);
+                (0, logger_1.logger)("lock actual:%d lockedTime:%d", actual, lockedTime);
+                if (!metadata || metadata.pID === process.pid || lockedTime > options.lockTimeout) {
+                    (0, logger_1.logger)("lock locking");
+                    (0, metadata_1.saveMetadata)(lockFile, lockTime).then(done, next);
+                }
+                else {
+                    (0, logger_1.logger)("lock next iteration");
+                    next();
+                }
+            }, next);
+        });
+        return tryToLock();
     });
-    return tryToLock();
-});
+}
 exports.lock = lock;
 //# sourceMappingURL=lock.js.map

package/lock.js.map

@@ -1 +1 @@
-{"version":3,"file":"lock.js","sourceRoot":"","sources":["../src/lock.ts"],"names":[],"mappings":";;;;AAAA,qCAAkC;AAClC,qCAAkD;AAClD,2BAAgC;AAChC,yCAAsE;AAStE,MAAM,eAAe,GAAgB;IACjC,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,GAAG;CACnB,CAAC;AACF,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB,MAAa,SAAU,SAAQ,KAAK;CACnC;AADD,8BACC;AAEM,MAAM,IAAI,GAAiB,CAAO,IAAY,EAAE,UAAuB,EAAE,EAA2B,EAAE;IACzG,OAAO,mCACA,eAAe,GACf,OAAO,CACb,CAAC;IAEF,eAAM,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;IAC5B,eAAM,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAEnC,IAAI,CAAC,eAAU,CAAC,IAAI,CAAC,EAAE;QACnB,eAAM,CAAC,0BAA0B,CAAC,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,mBAAmB,CAAC,CAAC;KAC/D;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,GAAG,IAAI,OAAO,CAAC;IAEhC,MAAM,SAAS,GAAG,GAA4B,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,eAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QAE3B,IAAI,GAAG,GAAG,QAAQ,IAAI,OAAO,CAAC,WAAW,EAAE;YACvC,eAAM,CAAC,qBAAqB,CAAC,CAAC;YAC9B,OAAO,MAAM,CAAC,IAAI,SAAS,CAAC,uBAAuB,IAAI,2BAA2B,OAAO,CAAC,WAAW,OAAO,CAAC,CAAC,CAAC;SAClH;QAED,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,eAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAEpD,MAAM,IAAI,GAAG,GAAG,EAAE;YACd,eAAM,CAAC,eAAe,CAAC,CAAC;YACxB,UAAU,CAAC,GAAG,EAAE;gBACZ,eAAM,CAAC,sBAAsB,CAAC,CAAC;gBAC/B,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACnC,CAAC,EAAE,QAAQ,CAAC,CAAC;QACjB,CAAC,CAAC;QAEF,IAAI,GAAG,GAA0B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,eAAU,CAAC,QAAQ,CAAC,EAAE;YACtB,eAAM,CAAC,oBAAoB,CAAC,CAAC;YAC7B,GAAG,GAAG,uBAAY,CAAC,QAAQ,CAAC,CAAC;SAChC;QACD,GAAG,CAAC,IAAI,CAAC,CAAC,QAAsB,EAAQ,EAAE;YACtC,MAAM,MAAM,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;YAClC,MAAM,UAAU,GAAW,QAAQ,CAAC,CAAC,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtE,eAAM,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;YACrC,eAAM,CAAC,8BAA8B,EAAE,MAAM,EAAE,UAAU,CAAE,CAAC;YAC5D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,IAAI,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE;gBAC/E,eAAM,CAAC,cAAc,CAAC,CAAA;gBACtB,uBAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;aACrD;iBAAM;gBACH,eAAM,CAAC,qBAAqB,CAAC,CAAC;gBAC9B,IAAI,EAAE,CAAC;aACV;QACL,CAAC,EAAE,IAAI,CAAC,CAAC;IACb,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,EAAE,CAAC;AACvB,CAAC,CAAA,CAAC;AAzDW,QAAA,IAAI,QAyDf"}
+{"version":3,"file":"lock.js","sourceRoot":"","sources":["../src/lock.ts"],"names":[],"mappings":";;;;AAAA,qCAAkC;AAClC,qCAAkC;AAClC,2BAAgC;AAChC,yCAAsE;AAOtE,MAAM,eAAe,GAAgB;IACjC,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,GAAG;CACnB,CAAC;AACF,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB,MAAa,SAAU,SAAQ,KAAK;CACnC;AADD,8BACC;AAKD;;;;;;;;;GASG;AACH,SAAsB,IAAI,CAAC,IAAY,EAAE,UAAuB,EAAE;;QAC9D,OAAO,mCACA,eAAe,GACf,OAAO,CACb,CAAC;QAEF,IAAA,eAAM,EAAC,cAAc,EAAE,IAAI,CAAC,CAAA;QAC5B,IAAA,eAAM,EAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAEnC,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,EAAE;YACnB,IAAA,eAAM,EAAC,0BAA0B,CAAC,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,mBAAmB,CAAC,CAAC;SAC/D;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,GAAG,IAAI,OAAO,CAAC;QAEhC,MAAM,SAAS,GAAG,GAA4B,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,IAAA,eAAM,EAAC,aAAa,EAAE,GAAG,CAAC,CAAC;YAE3B,IAAI,GAAG,GAAG,QAAQ,IAAI,OAAO,CAAC,WAAW,EAAE;gBACvC,IAAA,eAAM,EAAC,qBAAqB,CAAC,CAAC;gBAC9B,OAAO,MAAM,CAAC,IAAI,SAAS,CAAC,uBAAuB,IAAI,2BAA2B,OAAO,CAAC,WAAW,OAAO,CAAC,CAAC,CAAC;aAClH;YAED,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,eAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAEpD,MAAM,IAAI,GAAG,GAAG,EAAE;gBACd,IAAA,eAAM,EAAC,eAAe,CAAC,CAAC;gBACxB,UAAU,CAAC,GAAG,EAAE;oBACZ,IAAA,eAAM,EAAC,sBAAsB,CAAC,CAAC;oBAC/B,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACnC,CAAC,EAAE,QAAQ,CAAC,CAAC;YACjB,CAAC,CAAC;YAEF,IAAI,GAAG,GAA0B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,IAAA,eAAU,EAAC,QAAQ,CAAC,EAAE;gBACtB,IAAA,eAAM,EAAC,oBAAoB,CAAC,CAAC;gBAC7B,GAAG,GAAG,IAAA,uBAAY,EAAC,QAAQ,CAAC,CAAC;aAChC;YACD,GAAG,CAAC,IAAI,CAAC,CAAC,QAAsB,EAAQ,EAAE;gBACtC,MAAM,MAAM,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;gBAClC,MAAM,UAAU,GAAW,QAAQ,CAAC,CAAC,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACtE,IAAA,eAAM,EAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;gBACrC,IAAA,eAAM,EAAC,8BAA8B,EAAE,MAAM,EAAE,UAAU,CAAE,CAAC;gBAC5D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,IAAI,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE;oBAC/E,IAAA,eAAM,EAAC,cAAc,CAAC,CAAA;oBACtB,IAAA,uBAAY,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBACrD;qBAAM;oBACH,IAAA,eAAM,EAAC,qBAAqB,CAAC,CAAC;oBAC9B,IAAI,EAAE,CAAC;iBACV;YACL,CAAC,EAAE,IAAI,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,EAAE,CAAC;IACvB,CAAC;CAAA;AAzDD,oBAyDC"}

package/metadata.js

@@ -10,21 +10,21 @@ const logger_1 = require("./logger");
  */
 const readMetadata = (file) => {
     return new Promise((resolve, reject) => {
-        logger_1.logger("readMetadata file:%s", file);
-        fs_1.readFile(file, { encoding: "utf8" }, (err, data) => {
-            logger_1.logger("readMetadata err:%s", err);
-            logger_1.logger("readMetadata data:%O", data);
+        (0, logger_1.logger)("readMetadata file:%s", file);
+        (0, fs_1.readFile)(file, { encoding: "utf8" }, (err, data) => {
+            (0, logger_1.logger)("readMetadata err:%s", err);
+            (0, logger_1.logger)("readMetadata data:%O", data);
             if (err) {
                 reject(err);
             }
             else {
                 try {
                     const parsed = JSON.parse(String(data));
-                    logger_1.logger("readMetadata parsed:%O", parsed);
+                    (0, logger_1.logger)("readMetadata parsed:%O", parsed);
                     resolve(parsed);
                 }
                 catch (e) {
-                    logger_1.logger("readMetadata not JSON:%s", e);
+                    (0, logger_1.logger)("readMetadata not JSON:%s", e);
                     resolve(null);
                 }
             }
@@ -40,15 +40,15 @@ exports.readMetadata = readMetadata;
  */
 const saveMetadata = (file, lockTime) => {
     return new Promise((resolve, reject) => {
-        logger_1.logger("saveMetadata file:%s", file);
-        logger_1.logger("saveMetadata lockTime:%d", lockTime);
+        (0, logger_1.logger)("saveMetadata file:%s", file);
+        (0, logger_1.logger)("saveMetadata lockTime:%d", lockTime);
         const metadata = {
             pID: process.pid,
             lockTime
         };
-        logger_1.logger("saveMetadata metadata:%o", metadata);
-        fs_1.writeFile(file, JSON.stringify(metadata), { encoding: "utf8" }, (err) => {
-            logger_1.logger("saveMetadata done err:%o", err);
+        (0, logger_1.logger)("saveMetadata metadata:%o", metadata);
+        (0, fs_1.writeFile)(file, JSON.stringify(metadata), { encoding: "utf8" }, (err) => {
+            (0, logger_1.logger)("saveMetadata done err:%o", err);
             if (err) {
                 reject(err);
             }

package/metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":";;;AAAA,2BAAyC;AACzC,qCAAkC;AAOlC;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,IAAY,EAAyB,EAAE;IAChE,OAAO,IAAI,OAAO,CAAe,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;QACvD,eAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QACrC,aAAQ,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,GAAU,EAAE,IAAY,EAAE,EAAE;YAC9D,eAAM,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAA;YAClC,eAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;YACrC,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;iBAAM;gBACH,IAAI;oBACA,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBACxC,eAAM,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;oBACzC,OAAO,CAAC,MAAM,CAAC,CAAC;iBACnB;gBAAC,OAAO,CAAC,EAAE;oBACR,eAAM,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC;oBACtC,OAAO,CAAC,IAAI,CAAC,CAAC;iBACjB;aACJ;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AApBW,QAAA,YAAY,gBAoBvB;AAEF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAiB,EAAE;IAC1E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,eAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAA;QACpC,eAAM,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAiB;YAC3B,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,QAAQ;SACX,CAAC;QACF,eAAM,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAC;QAC7C,cAAS,CACL,IAAI,EACJ,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EACxB,EAAE,QAAQ,EAAE,MAAM,EAAE,EACpB,CAAC,GAAU,EAAQ,EAAE;YACjB,eAAM,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;YACxC,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;iBAAM;gBACH,OAAO,EAAE,CAAC;aACb;QACL,CAAC,CACJ,CAAA;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAvBW,QAAA,YAAY,gBAuBvB"}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":";;;AAAA,2BAAyC;AACzC,qCAAkC;AAOlC;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,IAAY,EAAyB,EAAE;IAChE,OAAO,IAAI,OAAO,CAAe,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;QACvD,IAAA,eAAM,EAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QACrC,IAAA,aAAQ,EAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,GAAU,EAAE,IAAY,EAAE,EAAE;YAC9D,IAAA,eAAM,EAAC,qBAAqB,EAAE,GAAG,CAAC,CAAA;YAClC,IAAA,eAAM,EAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;YACrC,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;iBAAM;gBACH,IAAI;oBACA,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBACxC,IAAA,eAAM,EAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;oBACzC,OAAO,CAAC,MAAM,CAAC,CAAC;iBACnB;gBAAC,OAAO,CAAC,EAAE;oBACR,IAAA,eAAM,EAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC;oBACtC,OAAO,CAAC,IAAI,CAAC,CAAC;iBACjB;aACJ;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AApBW,QAAA,YAAY,gBAoBvB;AAEF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAiB,EAAE;IAC1E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,IAAA,eAAM,EAAC,sBAAsB,EAAE,IAAI,CAAC,CAAA;QACpC,IAAA,eAAM,EAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAiB;YAC3B,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,QAAQ;SACX,CAAC;QACF,IAAA,eAAM,EAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAC;QAC7C,IAAA,cAAS,EACL,IAAI,EACJ,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EACxB,EAAE,QAAQ,EAAE,MAAM,EAAE,EACpB,CAAC,GAAU,EAAQ,EAAE;YACjB,IAAA,eAAM,EAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;YACxC,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;iBAAM;gBACH,OAAO,EAAE,CAAC;aACb;QACL,CAAC,CACJ,CAAA;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAvBW,QAAA,YAAY,gBAuBvB"}

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "cross-process-lock",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Cross-process file locking solution with lock-queue",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "tsc:watch": "tsc -w",
-    "build": "npm run clean && npm run buildUpdate && npm test",
-    "buildUpdate": "npm run compile && npm run copyToDist",
+    "build": "npm run buildUpdate && npm test && npm run docs",
+    "buildUpdate": "npm run clean && npm run compile && npm run copyToDist",
     "copyToDist": "copyfiles -f *.txt *.md package.json dist",
-    "clean": "rimraf ./dist ./reports ./docs ./tmp-*",
-    "test": "cross-env JEST_JUNIT_OUTPUT_DIR=./reports/junit jest",
-    "tslint": "tslint -c tslint.json ./src/*.ts ./tests/*.ts --fix",
-    "compile": "tsc && npm run tslint"
+    "docs": "typedoc --out ./docs ./src && touch ./docs/.nojekyll",
+    "clean": "rimraf ./dist ./docs ./reports ./coverage",
+    "test": "dotenv-ng --var JEST_JUNIT_OUTPUT_DIR=./reports -- jest --coverage",
+    "lint": "eslint . --ext .ts --fix",
+    "compile": "tsc && npm run lint"
   },
   "repository": {
     "type": "git",
@@ -29,34 +29,41 @@
   },
   "homepage": "https://github.com/szikszail/cross-process-lock#readme",
   "files": [
-    "*.js",
-    "*.d.ts",
-    "*.js.map"
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.js.map"
   ],
   "engines": {
-    "node": ">=6.0.0"
+    "node": ">=14.0.0"
   },
   "dependencies": {
-    "debug": "^4.3.1",
-    "tslib": "^2.1.0"
+    "tslib": "^2.5.0",
+    "debug": "^4.3.4"
   },
   "devDependencies": {
-    "@types/debug": "^4.1.5",
-    "@types/jest": "^26.0.20",
-    "@types/node": "^14.14.22",
+    "@types/debug": "^4.1.7",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.52.0",
+    "@typescript-eslint/parser": "^5.52.0",
     "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.3",
-    "jest": "^26.6.3",
-    "jest-junit": "^12.0.0",
+    "dotenv-ng": "^1.1.3",
+    "jest": "^29.4.2",
+    "jest-junit": "^15.0.0",
     "proxyquire": "^2.1.3",
-    "rimraf": "^3.0.2",
-    "sinon": "^9.2.4",
-    "ts-jest": "^26.4.4",
-    "tslint": "^6.1.3",
-    "typescript": "^4.1.3",
-    "yargs": "^16.2.0"
+    "rimraf": "^4.1.2",
+    "sinon": "^15.0.1",
+    "eslint": "^8.34.0",
+    "ts-jest": "^29.0.5",
+    "typedoc": "^0.23.25",
+    "typescript": "^4.9.5",
+    "yargs": "^17.6.2"
   },
   "jest": {
+    "reporters": [
+      "default",
+      "jest-junit"
+    ],
     "transform": {
       "^.+\\.ts?$": "ts-jest"
     },
@@ -68,16 +75,14 @@
       "/node_modules/",
       "dist"
     ],
-    "testResultsProcessor": "jest-junit",
-    "collectCoverage": true,
-    "coverageDirectory": "./reports/coverage",
+    "coverageDirectory": "./coverage",
+    "collectCoverageFrom": [
+      "./src/**/*.ts"
+    ],
     "moduleFileExtensions": [
       "ts",
       "js"
     ],
-    "collectCoverageFrom": [
-      "src/*.ts"
-    ],
     "coverageThreshold": {
       "global": {
         "branches": 85,

package/unlock.d.ts

@@ -1,2 +1,7 @@
-export declare type UnlockFunction = (file?: string) => Promise<void>;
-export declare const unlock: UnlockFunction;
+/**
+ * Releases the cross-process lock for the given file, for the actual process.
+ *
+ * @param file The path of the file to lock.
+ * @returns
+ */
+export declare function unlock(file: string): Promise<void>;

package/unlock.js

@@ -5,25 +5,33 @@ const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const logger_1 = require("./logger");
 const metadata_1 = require("./metadata");
-const unlock = (file) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    logger_1.logger("unlock file:%s", file);
-    const lockFile = `${file}.lock`;
-    if (!fs_1.existsSync(lockFile)) {
-        logger_1.logger("unlock lock file does not exist");
-        return;
-    }
-    const metadata = yield metadata_1.readMetadata(lockFile);
-    if (!metadata || metadata.pID === process.pid) {
-        try {
-            fs_1.unlinkSync(lockFile);
+/**
+ * Releases the cross-process lock for the given file, for the actual process.
+ *
+ * @param file The path of the file to lock.
+ * @returns
+ */
+function unlock(file) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        (0, logger_1.logger)("unlock file:%s", file);
+        const lockFile = `${file}.lock`;
+        if (!(0, fs_1.existsSync)(lockFile)) {
+            (0, logger_1.logger)("unlock lock file does not exist");
+            return;
         }
-        catch (e) {
-            logger_1.logger("unlock error during deleting lock file:%s", e);
+        const metadata = yield (0, metadata_1.readMetadata)(lockFile);
+        if (!metadata || metadata.pID === process.pid) {
+            try {
+                (0, fs_1.unlinkSync)(lockFile);
+            }
+            catch (e) {
+                (0, logger_1.logger)("unlock error during deleting lock file:%s", e);
+            }
         }
-    }
-    else {
-        logger_1.logger("unlock foreign lock file");
-    }
-});
+        else {
+            (0, logger_1.logger)("unlock foreign lock file");
+        }
+    });
+}
 exports.unlock = unlock;
 //# sourceMappingURL=unlock.js.map

package/unlock.js.map

@@ -1 +1 @@
-{"version":3,"file":"unlock.js","sourceRoot":"","sources":["../src/unlock.ts"],"names":[],"mappings":";;;;AAAA,2BAA4C;AAC5C,qCAAkC;AAClC,yCAAwD;AAIjD,MAAM,MAAM,GAAmB,CAAO,IAAY,EAAiB,EAAE;IACxE,eAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAE/B,MAAM,QAAQ,GAAW,GAAG,IAAI,OAAO,CAAC;IAExC,IAAI,CAAC,eAAU,CAAC,QAAQ,CAAC,EAAE;QACvB,eAAM,CAAC,iCAAiC,CAAC,CAAC;QAC1C,OAAO;KACV;IAED,MAAM,QAAQ,GAAiB,MAAM,uBAAY,CAAC,QAAQ,CAAC,CAAC;IAC5D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE;QAC3C,IAAI;YACA,eAAU,CAAC,QAAQ,CAAC,CAAC;SACxB;QAAC,OAAO,CAAC,EAAE;YACR,eAAM,CAAC,2CAA2C,EAAE,CAAC,CAAC,CAAC;SAC1D;KACJ;SAAM;QACH,eAAM,CAAC,0BAA0B,CAAC,CAAC;KACtC;AACL,CAAC,CAAA,CAAC;AApBW,QAAA,MAAM,UAoBjB"}
+{"version":3,"file":"unlock.js","sourceRoot":"","sources":["../src/unlock.ts"],"names":[],"mappings":";;;;AAAA,2BAA4C;AAC5C,qCAAkC;AAClC,yCAAwD;AAExD;;;;;GAKG;AACH,SAAsB,MAAM,CAAC,IAAY;;QACrC,IAAA,eAAM,EAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QAE/B,MAAM,QAAQ,GAAG,GAAG,IAAI,OAAO,CAAC;QAEhC,IAAI,CAAC,IAAA,eAAU,EAAC,QAAQ,CAAC,EAAE;YACvB,IAAA,eAAM,EAAC,iCAAiC,CAAC,CAAC;YAC1C,OAAO;SACV;QAED,MAAM,QAAQ,GAAiB,MAAM,IAAA,uBAAY,EAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE;YAC3C,IAAI;gBACA,IAAA,eAAU,EAAC,QAAQ,CAAC,CAAC;aACxB;YAAC,OAAO,CAAC,EAAE;gBACR,IAAA,eAAM,EAAC,2CAA2C,EAAE,CAAC,CAAC,CAAC;aAC1D;SACJ;aAAM;YACH,IAAA,eAAM,EAAC,0BAA0B,CAAC,CAAC;SACtC;IACL,CAAC;CAAA;AApBD,wBAoBC"}

package/with.d.ts

@@ -0,0 +1,23 @@
+import { LockOptions } from "./lock";
+export type LockCallback<T> = () => Promise<T>;
+/**
+ * Executes the callback with locking the given file before,
+ * and releasing it after the callback is executed.
+ *
+ * Generally, the callback/operation should target the file locked.
+ *
+ * @param file The path of the file to lock.
+ * @param callback The function to execute while the file is locked.
+ */
+export declare function withLock<T>(file: string, callback: LockCallback<T>): Promise<T>;
+/**
+ * Executes the callback with locking the given file before,
+ * and releasing it after the callback is executed.
+ *
+ * Generally, the callback/operation should target the file locked.
+ *
+ * @param file The path of the file to lock.
+ * @param options The lock options/timeout.
+ * @param callback The function to execute while the file is locked.
+ */
+export declare function withLock<T>(file: string, options: LockOptions, callback: LockCallback<T>): Promise<T>;

package/with.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withLock = void 0;
+const tslib_1 = require("tslib");
+const lock_1 = require("./lock");
+function withLock(file, options, callback) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        if (typeof options === "function") {
+            callback = options;
+            options = {};
+        }
+        if (typeof callback !== "function") {
+            throw new TypeError("Callback function must be set!");
+        }
+        const unlock = yield (0, lock_1.lock)(file, options);
+        try {
+            return callback();
+        }
+        finally {
+            yield unlock();
+        }
+    });
+}
+exports.withLock = withLock;
+//# sourceMappingURL=with.js.map

package/with.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"with.js","sourceRoot":"","sources":["../src/with.ts"],"names":[],"mappings":";;;;AAAA,iCAA2C;AAyB3C,SAAsB,QAAQ,CAAI,IAAY,EAAE,OAAsC,EAAE,QAA0B;;QAC9G,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAC/B,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;SAChB;QACD,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;YAChC,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;SACzD;QACD,MAAM,MAAM,GAAG,MAAM,IAAA,WAAI,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,IAAI;YACA,OAAO,QAAQ,EAAE,CAAC;SACrB;gBAAS;YACN,MAAM,MAAM,EAAE,CAAC;SAClB;IACL,CAAC;CAAA;AAdD,4BAcC"}

package/CHANGELOG.md

@@ -1,26 +0,0 @@
-# cross-process-lock
-
-## 2.0.1
-
-### Fixed
-
-* Added `tslib`
-* Fixed default timeouts
-
-## 2.0.0
-
-### Changed
-
-* Refactored to TypeScript
-* Replaced log4js logger with debug
-
-## 1.0.0
-
-### Added
-
-* Added lock and unlock methods
-* Added tests and documentation
-
-## 0.0.1
-
-Initial development release