Class FileSystemLockingImpl

Use this backend service to help prevent race access to files on disk.

Implements

FileSystemLocking

Index

Constructors

Methods

cleanupLocks getLock getLocks initializeLocks lockPath resolveLockPath

Constructors

constructor

new FileSystemLockingImpl(): FileSystemLockingImpl
Returns FileSystemLockingImpl

Methods

`Protected` cleanupLocks

cleanupLocks(locks): void
Parameters
- locks: Map<string, Mutex>
Returns void
- Defined in packages/core/src/node/filesystem-locking.ts:61

`Protected` getLock

getLock(lockPath): Mutex
Parameters
- lockPath: string
Returns Mutex
- Defined in packages/core/src/node/filesystem-locking.ts:69

`Protected` getLocks

getLocks(): Map<string, Mutex>
Returns Map<string, Mutex>
- Defined in packages/core/src/node/filesystem-locking.ts:48

`Protected` initializeLocks

initializeLocks(): Map<string, Mutex>
Returns Map<string, Mutex>
- Defined in packages/core/src/node/filesystem-locking.ts:54

lockPath

lockPath<T>(lockPath, transaction, thisArg?): Promise<T>
Get exclusive access to a file for reading and/or writing.
Type Parameters
- T
Parameters
- lockPath: string
  The path to request exclusive access to.
- transaction: ((lockPath) => T | Promise<T>)
  The job to do while having exclusive access.
  - - (lockPath): T | Promise<T>
    - Parameters
      lockPath: string
      Returns T | Promise<T>
- Optional thisArg: unknown
  this argument used when calling transaction.
Returns Promise<T>
Implementation of FileSystemLocking.lockPath
- Defined in packages/core/src/node/filesystem-locking.ts:38

`Protected` resolveLockPath

resolveLockPath(lockPath): string
Parameters
- lockPath: string
Returns string
- Defined in packages/core/src/node/filesystem-locking.ts:43