Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AsyncKeyValueFile

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _fs

_fs: AsyncKeyValueFileSystem

Methods

advancePos

  • advancePos(delta: number): number

chmod

chmodSync

  • chmodSync(mode: number): void

chown

chownSync

  • chownSync(uid: number, gid: number): void

close

closeSync

  • closeSync(): void

datasync

datasyncSync

  • datasyncSync(): void

getBuffer

  • getBuffer(): Buffer

getFlag

getPath

  • getPath(): string

getPos

  • getPos(): number

  • Get the current file position.

    We emulate the following bug mentioned in the Node documentation:

    On Linux, positional writes don't work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to the end of the file.

    Returns number

    The current file position.

getStats

Protected isDirty

  • isDirty(): boolean

read

  • read(buffer: Buffer, offset: number, length: number, position: number, cb: BFSThreeArgCallback): void

  • Read data from the file.

    Parameters

    • buffer: Buffer

      The buffer that the data will be written to.

    • offset: number

      The offset within the buffer where writing will start.

    • length: number

      An integer specifying the number of bytes to read.

    • position: number

      An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.

    • cb: BFSThreeArgCallback

      The number is the number of bytes read

    Returns void

readSync

  • readSync(buffer: Buffer, offset: number, length: number, position: number): number

  • Read data from the file.

    Parameters

    • buffer: Buffer

      The buffer that the data will be written to.

    • offset: number

      The offset within the buffer where writing will start.

    • length: number

      An integer specifying the number of bytes to read.

    • position: number

      An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.

    Returns number

Protected resetDirty

  • resetDirty(): void

setPos

  • setPos(newPos: number): number

stat

statSync

sync

syncSync

  • syncSync(): void

truncate

truncateSync

  • truncateSync(len: number): void

utimes

utimesSync

  • utimesSync(atime: Date, mtime: Date): void

write

  • write(buffer: Buffer, offset: number, length: number, position: number, cb: BFSThreeArgCallback): void

  • Write buffer to the file. Note that it is unsafe to use fs.write multiple times on the same file without waiting for the callback.

    Parameters

    • buffer: Buffer

      Buffer containing the data to write to the file.

    • offset: number

      Offset in the buffer to start reading data from.

    • length: number

      The amount of bytes to write to the file.

    • position: number

      Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.

    • cb: BFSThreeArgCallback

    Returns void

writeSync

  • writeSync(buffer: Buffer, offset: number, length: number, position: number): number

  • Write buffer to the file. Note that it is unsafe to use fs.writeSync multiple times on the same file without waiting for the callback.

    Parameters

    • buffer: Buffer

      Buffer containing the data to write to the file.

    • offset: number

      Offset in the buffer to start reading data from.

    • length: number

      The amount of bytes to write to the file.

    • position: number

      Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.

    Returns number

Generated using TypeDoc