Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

Methods

seek

  • seek(offset: number, whence: number): Promise<void>
  • Seek sets the offset for the next read() or write() to offset, interpreted according to whence: SeekStart means relative to the start of the file, SeekCurrent means relative to the current offset, and SeekEnd means relative to the end. Seek returns the new offset relative to the start of the file and an error, if any.

    Seeking to an offset before the start of the file is an error. Seeking to any positive offset is legal, but the behavior of subsequent I/O operations on the underlying object is implementation-dependent.

    Parameters

    • offset: number
    • whence: number

    Returns Promise<void>

write

  • write(p: Uint8Array): Promise<number>
  • Writes p.byteLength bytes from p to the underlying data stream. It resolves to the number of bytes written from p (0 <= n <= p.byteLength) and any error encountered that caused the write to stop early. write() must return a non-null error if it returns n < p.byteLength. write() must not modify the slice data, even temporarily.

    Implementations must not retain p.

    Parameters

    • p: Uint8Array

    Returns Promise<number>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc