openFile

Open an existing file in a BrowserPod Pod's virtual filesystem, returning a BinaryFile or TextFile handle depending on the mode you pass.

class BrowserPod {
async openFile(path: string, mode: string): Promise<BinaryFile | TextFile>;
}

Parameters

  • path (string) - Path to an existing file.
  • mode (string) - Opening mode. Either “binary” or “utf-8”.

Returns

openFile returns a Promise which resolves to a BinaryFile object if mode="binary", and to a TextFile object if mode="utf-8". If the file does not exist, the Promise will be rejected.

Was this page helpful?
Suggest changes