Class File

constructor

• new File(link: Link, node: Node, flags: number, fd: number): File

  Open a Link-Node pair. node is provided separately as that might be a different node rather the one link points to, because it might be a symlink.

  Parameters

  • link: Link
  • node: Node
  • flags: number
  • fd: number

  Returns File

fd

flags

Readonlylink

Readonlynode

position

chmod

• chmod(perm: number): void

  Parameters

  • perm: number

  Returns void

chown

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

  Parameters

  • uid: number
  • gid: number

  Returns void

getBuffer

• getBuffer(): Buffer

  Returns Buffer

getSize

• getSize(): number

  Returns number

getString

• getString(encoding?: string): string

  Parameters

  • Optionalencoding: string

  Returns string

read

• read(
      buf:
          | Buffer<ArrayBufferLike>
          | DataView<ArrayBufferLike>
          | ArrayBufferView<ArrayBufferLike>,
      offset?: number,
      length?: number,
      position?: number,
  ): number

  Parameters

  • buf:
        | Buffer<ArrayBufferLike>
        | DataView<ArrayBufferLike>
        | ArrayBufferView<ArrayBufferLike>
  • Optionaloffset: number
  • Optionallength: number
  • Optionalposition: number

  Returns number

seekTo

• seekTo(position: number): void

  Parameters

  • position: number

  Returns void

setBuffer

• setBuffer(buf: Buffer): void

  Parameters

  • buf: Buffer

  Returns void

setString

• setString(str: string): void

  Parameters

  • str: string

  Returns void

truncate

• truncate(len?: number): void

  Parameters

  • Optionallen: number

  Returns void

write

• write(
      buf: Buffer,
      offset?: number,
      length?: number,
      position?: number | null,
  ): number

  Parameters

  • buf: Buffer
  • Optionaloffset: number
  • Optionallength: number
  • Optionalposition: number | null

  Returns number