Class LockFile

Hierarchy

LockFile

Index

Constructors

Properties

file? uuid? events files mutex

Methods

unlock unlockCleanup checkLock createLock lock waitForLock

Constructors

constructor

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

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:248

`Protected` unlockCleanup

unlockCleanup(fileio?): 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:281

`Static` `Protected` checkLock

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

`Static` `Protected` createLock

createLock(file): 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:196

`Static` lock

lock(file): 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:66

`Static` `Protected` waitForLock

waitForLock(file): 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:142

Generated using TypeDoc