Options
All
  • Public
  • Public/Protected
  • All
Menu

Class File

Represents a Controller.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new File(path: string): File

  • Creates a File object for the specified path. Paths can be absolute or relative to the JavaScript file being executed.

    Throws an exception if the file does not exist at the specified path.

    Parameters

    • path: string

    Returns File

Properties

Optional id

id: ObjectID | undefined

The identifier of this object.

Methods

loadFileAsData

  • loadFileAsData(): ArrayBuffer

  • Loads a file's contents into memory as a block of binary data.

    Returns ArrayBuffer

loadFileAsString

  • loadFileAsString(): string

  • Reads a file into memory as a string.

    Returns string

Generated using TypeDoc