Class File

constructor

• new File(path: string): File

  Constructor.

  Parameters

  • path: string

    The file path.

  Returns File

Readonlypath

exists

• get exists(): boolean

  Whether the file currently exists.

  Returns boolean

write

• write(data: Uint8Array): void

  Writes the specified binary data to the file.

  Parameters

  • data: Uint8Array

    The binary data.

  Returns void

  Throws

  Error Exception is thrown if the file could not be written.

Staticcombine

• combine(lhs: string, rhs: string): string

  Combines two paths.

  Parameters

  • lhs: string

    The first path.
  • rhs: string

    The second path.

  Returns string

  The combined path.

Staticcopy

• copy(sourcePath: string, destinationPath: string): void

  Copies a file from the specified source path to the specified destination path.

  Parameters

  • sourcePath: string

    The source file path.
  • destinationPath: string

    The destination file path.

  Returns void

Staticcreate

• create(path: string): void

  Creates an empty file at the specified path.

  Parameters

  • path: string

    The file path.

  Returns void

Staticdelete

• delete(path: string): void

  Deletes the file at the specified path if it exists.

  Parameters

  • path: string

    The file path.

  Returns void

Staticdirectory

• directory(path: string): string

  Extracts the directory path from the specified file path.

  Parameters

  • path: string

    The file path.

  Returns string

  The directory path.

  Remarks

  The trailing forward slash is not included in the returned directory path.

Staticexists

• exists(path: string): boolean

  Whether a file or directory exists at the specified path.

  Parameters

  • path: string

    The path.

  Returns boolean

  True if the file or directory exists, false otherwise.

Staticextension

• extension(path: string): string

  Extracts the file extension from the specified file path.

  Parameters

  • path: string

    The file path.

  Returns string

  The file extension.

  Remarks

  The period is not included in the returned file extension.

Staticfilename

• filename(path: string, includeExtension?: boolean): string

  Extracts the file name from the specified file path.

  Parameters

  • path: string

    The file path.
  • includeExtension: boolean = true

    Whether to include the extension in the file name.

  Returns string

  The file name.

StaticisDir

• isDir(path: string): boolean

  Whether a directory exists at the specified path.

  Parameters

  • path: string

    The path.

  Returns boolean

  True if a directory exists, false otherwise.

Staticlist

• list(path: string, includePath?: boolean): null | string[]

  Lists the contents of a directory.

  Parameters

  • path: string

    The directory path.
  • includePath: boolean = false

    Whether to include the directory path in the returned list of file names/paths.

  Returns null | string[]

  The list of file and subdirectory names/paths.

  Remarks

  This function does not recurse into any subdirectories, but it does include any subdirectories in the returned list.

StaticlistFilesRecursive

• listFilesRecursive(path: string): null | string[]

  Lists the contents of a directory and any subdirectories.

  Parameters

  • path: string

    The directory path.

  Returns null | string[]

  The list of file paths.

  Remarks

  This function recurses into subdirectories and does not include directories in the returned list.

Staticopen

• open(
      description?: undefined | string,
      mimetypes?: undefined | string[],
      extensions?: undefined | string[],
  ): Promise<ArrayBuffer>

  Prompts the user to open a file.

  Parameters

  • description: undefined | string = undefined

    The (optional) file type description.
  • mimetypes: undefined | string[] = undefined

    The (optional) array of supported mimetypes.
  • extensions: undefined | string[] = undefined

    The (optional) array of supported file extensions.

  Returns Promise<ArrayBuffer>

  The loaded data.

Staticread

• read(path: string): Uint8Array

  Reads the binary data from the file.

  Parameters

  • path: string

    The file path.

  Returns Uint8Array

  The binary data.

  Throws

  Error Exception is thrown if the file does not exist or could not be opened for reading.

Staticrename

• rename(sourcePath: string, destinationPath: string): void

  Moves the file at the the specified source path to the specified destination path.

  Parameters

  • sourcePath: string

    The source file path.
  • destinationPath: string

    The destination file path.

  Returns void

Staticsave

• save(
      data: ArrayBuffer,
      filename?: undefined | string,
      extensions?: undefined | string[],
  ): Promise<void>

  Prompts the user to save the specified binary data a file.

  Parameters

  • data: ArrayBuffer

    The binary data.
  • filename: undefined | string = undefined

    The (optional) default filename.
  • extensions: undefined | string[] = undefined

    The (optional) array of file extensions.

  Returns Promise<void>

Staticwrite

• write(path: string, data: Uint8Array): void

  Writes the specified binary data to a file.

  Parameters

  • path: string

    The file path.
  • data: Uint8Array

    The binary data.

  Returns void

  Throws

  Error Exception is thrown if the file could not be written.