Class DeviceFile

constructor

• new DeviceFile(fs, path, device): DeviceFile

• Parameters

  • fs: DeviceFS
  • path: string
  • device: Device<any>

  Returns DeviceFile

Readonlydevice

position

driver

• get driver(): DeviceDriver<any>

• Returns DeviceDriver<any>

_setType

• _setType(): Promise<void>
• Internal

  Set the file type

  Returns Promise<void>

_setTypeSync

• _setTypeSync(): void
• Internal

  Set the file type

  Returns void

chmod

• chmod(): Promise<void>

• Returns Promise<void>

chmodSync

• chmodSync(): void

• Returns void

chown

• chown(): Promise<void>

• Returns Promise<void>

chownSync

• chownSync(): void

• Returns void

close

• close(): Promise<void>

• Returns Promise<void>

closeSync

• closeSync(): void

• Returns void

read

• read<TBuffer>(buffer, offset?, length?): 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.

  Returns Promise<FileReadResult<TBuffer>>

  Promise resolving to the new length of the buffer

readSync

• 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

stat

• stat(): Promise<Stats>

• Returns Promise<Stats>

statSync

• statSync(): Stats

• Returns Stats

sync

• sync(): Promise<void>

• Returns Promise<void>

syncSync

• syncSync(): void

• Returns void

truncate

• truncate(length): Promise<void>

• Parameters

  • length: number

  Returns Promise<void>

truncateSync

• truncateSync(length): void

• Parameters

  • length: number

  Returns void

utimes

• utimes(): Promise<void>

• Change the file timestamps of the file.

  Returns Promise<void>

utimesSync

• utimesSync(): void

• Change the file timestamps of the file.

  Returns void

write

• 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

writeSync

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

• Write buffer to the file.

  Parameters

  • buffer: Uint8Array

    Uint8Array containing the data to write to the file.
  • offset: number = 0

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

    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