Class LockableFile

Hierarchy (View Summary)

LockableFile
- LockableLog

Index

Constructors

Properties

exclusive fileHandle fileLocked filename

Accessors

Methods

getFileLength lockFile unlockFile

Constructors

constructor

new LockableFile(filename: string, exclusive?: boolean): LockableFile
Parameters
- filename: string
- exclusive: boolean = false
Returns LockableFile
- Defined in implementation/LockableFile.ts:10

Properties

`Readonly`exclusive

exclusive: boolean = false

`Protected`fileHandle

fileHandle: FileHandle

`Protected`fileLocked

fileLocked: boolean = false

`Readonly`filename

filename: string

Accessors

ready

get ready(): Promise<void>
Returns Promise<void>
- Defined in implementation/LockableFile.ts:17

Methods

`Protected`getFileLength

getFileLength(): Promise<number>
Returns Promise<number>
- Defined in implementation/LockableFile.ts:54

`Protected`lockFile

lockFile(block: boolean): Promise<boolean>
Parameters
- block: boolean
Returns Promise<boolean>
- Defined in implementation/LockableFile.ts:28

`Protected`unlockFile

unlockFile(): Promise<void>
Returns Promise<void>
- Defined in implementation/LockableFile.ts:41