Class WalFile

Index

Constructors

Properties

#byteCounterTransform #column #fileHandle #fileSize #length #options #paused #readable #writer

Accessors

Methods

append close open read setPath stats truncate defaultOptions

Constructors

constructor

new WalFile(options, column): WalFile
Parameters
- options: IWalFileOptions
- column: Column
Returns WalFile
- Defined in src/files/Wal.ts:29

Properties

`Private` #byteCounterTransform

#byteCounterTransform: Transform

`Private` #column

#column: Column

`Private` #fileHandle

#fileHandle: FileHandle

`Private` #fileSize

#fileSize: number = -1

`Private` #length

#length: number

`Private` #options

#options: IWalFileOptions

`Private` #paused

#paused: boolean = false

`Private` #readable

#readable: Readable = ...

`Private` #writer

#writer: WriteStream

Accessors

fileSize

get fileSize(): number
Returns number
- Defined in src/files/Wal.ts:38

Methods

append

append(data, method): void
Parameters
- data: DataNode
- method: WalMethod
Returns void
- Defined in src/files/Wal.ts:98

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/files/Wal.ts:91

open

open(): Promise<void>
Returns Promise<void>
- Defined in src/files/Wal.ts:46

read

read(returnNode): Promise<DataNode[]>
Parameters
- returnNode: true
Returns Promise<DataNode[]>
- Defined in src/files/Wal.ts:120
read(returnNode): Promise<Uint8Array[]>
Parameters
- returnNode: false
Returns Promise<Uint8Array[]>
- Defined in src/files/Wal.ts:121

setPath

setPath(path): void
Parameters
- path: string
Returns void
- Defined in src/files/Wal.ts:42

stats

stats(): {
entries: number;
fileSize: number;
}
Returns {
entries: number;
fileSize: number;
}
- entries: number
- fileSize: number
- Defined in src/files/Wal.ts:146

truncate

truncate(): Promise<void>
Returns Promise<void>
- Defined in src/files/Wal.ts:135

`Static` defaultOptions

defaultOptions(): IWalFileOptions
Returns IWalFileOptions
- Defined in src/files/Wal.ts:153