Create a new FileSystemResourceLocker
Folder that stores the locks
Acquires a lock on the requested identifier. The promise will resolve when the lock has been acquired.
Generate LockOptions or UnlockOptions depending on the type of defauls given. A custom lockFilePath mapping strategy will be used.
ResourceIdentifier to generate (Un)LockOptions for
The default options. (lockFilePath will get overwritten)
LockOptions or UnlockOptions
Releases a lock on the requested identifier. The promise will resolve when the lock has been released. In case there is no lock on the resource an error should be thrown.
Wrapper function for all (un)lock operations. Any errors coming from the fn() will be swallowed.
Only ENOTACQUIRED errors wills be thrown (trying to release lock that didn't exist).
This wrapper returns undefined because {@link retryFunction} expects that when a retry needs to happne.s
The function reference to swallow errors from.
Boolean or undefined.
Wrapper function for all (un)lock operations. Any errors coming from the fn() will be swallowed.
Only ENOTACQUIRED errors wills be thrown (trying to release lock that didn't exist).
This wrapper returns undefined because {@link retryFunction} expects that when a retry needs to happne.s
Boolean or undefined.
Map the identifier path to a unique path inside the lockFolder.
ResourceIdentifier to generate (Un)LockOptions for.
Full path.
A resource locker making use of the proper-lockfile library. Note that no locks are kept in memory, thus this is considered thread- and process-safe.
This proper-lockfile library has its own retry mechanism for the operations, since a lock/unlock call will either resolve successfully or reject immediately with the causing error. The retry function of the library however will be ignored and replaced by our own LockUtils' {@link retryFunctionUntil} function.