Class LockFile

constructor

• new LockFile(file, lock): LockFile

• Parameters

  • file: File
  • lock: FileHandle

  Returns LockFile

Readonlyfile

Readonlylock

[toStringTag]

• get [toStringTag](): string

• Returns string

state

• get state(): LockFileState

• Returns LockFileState

appendFile

• appendFile(data, encoding?): Promise<void>

• Asynchronously append the given contents to this lock file.

  It is unsafe to call appendFile() multiple times on the same file without waiting for the Promise to be resolved (or rejected).

  Parameters

  • data: string | ArrayBufferView
  • Optionalencoding: Encoding

  Returns Promise<void>

commit

• commit(): Promise<void>

• Returns Promise<void>

rollback

• rollback(): Promise<void>

• Returns Promise<void>

writeFile

• writeFile(data, encoding?): Promise<void>

• Asynchronously writes the given contents to this lock file, replacing any old contents.

  It is unsafe to call writeFile() multiple times on the same file without waiting for the Promise to be resolved (or rejected).

  Parameters

  • data: string | ArrayBufferView
  • Optionalencoding: Encoding

  Returns Promise<void>

StaticforceUnlock

• forceUnlock(name, options?): Promise<void>

• Parameters

  • name: string | File
  • options: LockFileOptions = {}

  Returns Promise<void>

StaticisLocked

• isLocked(name, options?): Promise<"unlocked" | "locked" | "stale">

• Checks if the given file is locked.

  Parameters

  • name: string | File

    Name of the file to check.
  • options: LockFileOptions = {}

    Lock file options.

  Returns Promise<"unlocked" | "locked" | "stale">

  Lock status, one of "unlocked" "locked" or "stale".

Staticlock

• lock(name, options): Promise<LockFile>

• Attempts to lock the given file. Throws [[LockFileError]] if file cannot be locked.

  Parameters

  • name: string | File

    Name of the file to lock.
  • options: LockFileOptions & RetryOptions

    Lock file options.

  Returns Promise<LockFile>

  A promise which resolves with [[LockFile]] instance on success.

StaticwithLock

• withLock<T>(name, options, callback): Promise<T>

• Executes the given callback function after locking the given file. Throws [[LockFileError]] if file cannot be locked.

  Type Parameters

  • T

  Parameters

  • name: string | File

    Name of the file to lock.
  • options: LockFileOptions & RetryOptions

    Lock file options.
  • callback: ((lock: LockFile) => Promise<T>)

    A callback to executes once the file is locked.

    • • (lock): Promise<T>

      • Parameters

        • lock: LockFile

        Returns Promise<T>

  Returns Promise<T>

  The result of the callback.