Class LockFile

Index

Constructors

Properties

file? uuid? events files mutex

Methods

unlock unlockCleanup checkLock createLock lock waitForLock

Constructors

constructor

new LockFile(file: string, uuid: string): LockFile
Parameters
- file: string
- uuid: string
Returns LockFile
- Defined in packages/mongodb-memory-server-core/src/util/lockfile.ts:242

Properties

`Optional`file

file?: string

File locked by this instance

`Optional`uuid

uuid?: string

UUID Unique to this lock instance

`Static`events

events: LockFileEventsClass = ...

Listen for events from this process

`Static`files

files: Set<string> = ...

All Files that are handled by this process

`Static`mutex

mutex: Mutex = ...

Mutex to stop same-process race conditions

Methods

unlock

unlock(): Promise<void>
Unlock the File that is locked by this instance

Returns Promise<void>
- Defined in packages/mongodb-memory-server-core/src/util/lockfile.ts:250

`Protected`unlockCleanup

unlockCleanup(fileio?: boolean): Promise<void>
Helper function for the unlock-cleanup
Parameters
- fileio: boolean = true
  Unlink the file?
Returns Promise<void>
- Defined in packages/mongodb-memory-server-core/src/util/lockfile.ts:283

`Protected` `Static`checkLock

checkLock(file: string, uuid?: string): Promise<LockFileStatus>
Check the status of the lockfile
Parameters
- file: string
  The file to use as the LockFile
- Optionaluuid: string
Returns Promise<LockFileStatus>
- Defined in packages/mongodb-memory-server-core/src/util/lockfile.ts:93

`Protected` `Static`createLock

createLock(file: string): Promise<LockFile>
Function create the path and lock file
Parameters
- file: string
  The file to use as the LockFile
Returns Promise<LockFile>
- Defined in packages/mongodb-memory-server-core/src/util/lockfile.ts:198

`Static`lock

lock(file: string): Promise<LockFile>
Acquire an lockfile
Parameters
- file: string
  The file to use as the LockFile
Returns Promise<LockFile>
- Defined in packages/mongodb-memory-server-core/src/util/lockfile.ts:68

`Protected` `Static`waitForLock

waitForLock(file: string): Promise<LockFile>
Wait for the Lock file to become available
Parameters
- file: string
  The file to use as the LockFile
Returns Promise<LockFile>
- Defined in packages/mongodb-memory-server-core/src/util/lockfile.ts:144