Class File<FS>Abstract

constructor

• new File<FS>(fs, path): File<FS>

• Type Parameters

  • FS extends FileSystem = FileSystem

  Parameters

  • Internalfs: FileSystem

    The file system that created the file
  • path: string

  Returns File<FS>

Internalfs

Readonlypath

Abstractposition

[asyncDispose]

• [asyncDispose](): Promise<void>

• Returns Promise<void>

[dispose]

• [dispose](): void

• Returns void

Abstractchmod

• chmod(mode): Promise<void>

• Parameters

  • mode: number

  Returns Promise<void>

AbstractchmodSync

• chmodSync(mode): void

• Parameters

  • mode: number

  Returns void

Abstractchown

• chown(uid, gid): Promise<void>

• Parameters

  • uid: number
  • gid: number

  Returns Promise<void>

AbstractchownSync

• chownSync(uid, gid): void

• Parameters

  • uid: number
  • gid: number

  Returns void

Abstractclose

• close(): Promise<void>

• Returns Promise<void>

AbstractcloseSync

• closeSync(): void

• Returns void

datasync

• datasync(): Promise<void>

• Default implementation maps to sync.

  Returns Promise<void>

datasyncSync

• datasyncSync(): void

• Default implementation maps to syncSync.

  Returns void

Abstractread

• read<TBuffer>(buffer, offset?, length?, position?): Promise<FileReadResult<TBuffer>>

• Read data from the file.

  Type Parameters

  • TBuffer extends ArrayBufferView

  Parameters

  • buffer: TBuffer

    The buffer that the data will be written to.
  • Optionaloffset: number

    The offset within the buffer where writing will start.
  • Optionallength: number

    An integer specifying the number of bytes to read.
  • Optionalposition: 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 Promise<FileReadResult<TBuffer>>

  Promise resolving to the new length of the buffer

AbstractreadSync

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

• Read data from the file.

  Parameters

  • buffer: ArrayBufferView

    The buffer that the data will be written to.
  • Optionaloffset: number

    The offset within the buffer where writing will start.
  • Optionallength: number

    An integer specifying the number of bytes to read.
  • Optionalposition: 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

Abstractstat

• stat(): Promise<Stats>

• Returns Promise<Stats>

AbstractstatSync

• statSync(): Stats

• Returns Stats

Abstractsync

• sync(): Promise<void>

• Returns Promise<void>

AbstractsyncSync

• syncSync(): void

• Returns void

Abstracttruncate

• truncate(len): Promise<void>

• Parameters

  • len: number

  Returns Promise<void>

AbstracttruncateSync

• truncateSync(len): void

• Parameters

  • len: number

  Returns void

Abstractutimes

• utimes(atime, mtime): Promise<void>

• Change the file timestamps of the file.

  Parameters

  • atime: Date
  • mtime: Date

  Returns Promise<void>

AbstractutimesSync

• utimesSync(atime, mtime): void

• Change the file timestamps of the file.

  Parameters

  • atime: Date
  • mtime: Date

  Returns void

Abstractwrite

• write(buffer, offset?, length?, position?): Promise<number>

• Write buffer to the file.

  Parameters

  • buffer: Uint8Array

    Uint8Array containing the data to write to the file.
  • Optionaloffset: number

    Offset in the buffer to start reading data from.
  • Optionallength: number

    The amount of bytes to write to the file.
  • Optionalposition: 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 Promise<number>

  Promise resolving to the new length of the buffer

AbstractwriteSync

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

• Write buffer to the file.

  Parameters

  • buffer: Uint8Array

    Uint8Array containing the data to write to the file.
  • Optionaloffset: number

    Offset in the buffer to start reading data from.
  • Optionallength: number

    The amount of bytes to write to the file.
  • Optionalposition: 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