createFile

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

class BrowserPod {
async createFile(path: string, mode: "binary"): Promise<BinaryFile>;
async createFile(path: string, mode: "utf-8"): Promise<TextFile>;
}

Parameters

  • path (string) - Path of the newly-created file.
  • mode ("binary" | "utf-8") - Opening mode.

Returns

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

Calling createFile on an already existing file will wipe its contents.