Class LockableLog

Hierarchy (View Summary)

LockableFile
- LockableLog
  - LogBackedStore

Index

Constructors

Properties

exclusive fileHandle fileLocked filename

Accessors

Methods

getFileLength getLogContents lockFile unlockFile writeLogFragment writeMagicNumber

Constructors

constructor

new LockableLog(filename: string, exclusive?: boolean): LockableLog
Parameters
- filename: string
- exclusive: boolean = false
Returns LockableLog
Inherited from LockableFile.constructor
- 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>
Inherited from LockableFile.ready
- Defined in implementation/LockableFile.ts:17

Methods

`Protected`getFileLength

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

getLogContents

getLogContents(start?: number, finish?: number): Promise<LogFileBuilder>
Parameters
- start: number = 0
- Optionalfinish: number
Returns Promise<LogFileBuilder>
- Defined in implementation/LockableLog.ts:26

`Protected`lockFile

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

`Protected`unlockFile

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

`Protected`writeLogFragment

writeLogFragment(fragment: LogFileBuilder, sync?: boolean): Promise<number>
Parameters
- fragment: LogFileBuilder
- Optionalsync: boolean
Returns Promise<number>
- Defined in implementation/LockableLog.ts:15

`Protected`writeMagicNumber

writeMagicNumber(): Promise<number>
Returns Promise<number>
- Defined in implementation/LockableLog.ts:6