Class PortFile

constructor

• new PortFile(fs, fd, path, position): PortFile

• Parameters

  • fs: PortFS
  • fd: number
  • path: string
  • position: number

  Returns PortFile

Readonly fd

Readonly fs

_setType

• _setType(type): Promise<void>
• Internal

  Set the file type

  Parameters

  • type: FileType

  Returns Promise<void>

_setTypeSync

• _setTypeSync(): void
• Internal

  Set the file type

  Returns void

chmod

• chmod(mode): Promise<void>

• Asynchronous fchmod.

  Parameters

  • mode: number

  Returns Promise<void>

chmodSync

• chmodSync(): void

• Synchronous fchmod.

  Returns void

chown

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

• Asynchronous chown.

  Parameters

  • uid: number
  • gid: number

  Returns Promise<void>

chownSync

• chownSync(): void

• Synchronous chown.

  Returns void

close

• close(): Promise<void>

• Asynchronous close.

  Returns Promise<void>

closeSync

• closeSync(): void

• Synchronous close.

  Returns void

read

• 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.
  • Optional offset: number

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

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

  Promise resolving to the new length of the buffer

readSync

• readSync(): number

• Read data from the file.

  Returns number

rpc

• rpc<const T>(method, ...args): Promise<Awaited<ReturnType<FileMethods[T]>>>

• Type Parameters

  • const T extends "write" | "close" | "read" | "chmod" | "chown" | "stat" | "datasync" | "sync" | "truncate" | "utimes" | "_setType"

  Parameters

  • method: T
  • Rest ...args: Parameters<FileMethods[T]>

  Returns Promise<Awaited<ReturnType<FileMethods[T]>>>

stat

• stat(): Promise<Stats>

• Asynchronous stat.

  Returns Promise<Stats>

statSync

• statSync(): Stats

• Synchronous stat.

  Returns Stats

sync

• sync(): Promise<void>

• Asynchronous sync.

  Returns Promise<void>

syncSync

• syncSync(): void

• Synchronous sync.

  Returns void

truncate

• truncate(len): Promise<void>

• Asynchronous truncate.

  Parameters

  • len: number

  Returns Promise<void>

truncateSync

• truncateSync(): void

• Synchronous truncate.

  Returns void

utimes

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

• Change the file timestamps of the file.

  Parameters

  • atime: Date
  • mtime: Date

  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. Note that it is unsafe to use fs.write multiple times on the same file without waiting for the callback.

  Parameters

  • buffer: Uint8Array

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

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

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

  Promise resolving to the new length of the buffer

writeSync

• writeSync(): number

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

  Returns number