Class File

Provides basic filesystem access.

Hierarchy

File

Index

Constructors

Methods

close flush write

Constructors

constructor

new File(filePath: string, mode: string): File
Opens or creates the file at filePath with mode specifying how it should be opened. For example "wb" to open the file for writing in binary mode. This is the same format as fopen() from the C standard library.
Parameters
- filePath: string
  
  Path to file to open or create.
- mode: string
  
  Mode to use.
Returns File
- Defined in index.ts:2340

Methods

close

close(): void
Closes the file. You should call this function when you’re done with the file unless you are fine with this happening when the object is garbage-collected or the script is unloaded.

Returns void
- Defined in index.ts:2359

flush

flush(): void
Flushes any buffered data to the underlying file.

Returns void
- Defined in index.ts:2352

write

write(data: string | ArrayBuffer): void
Synchronously writes data to the file.
Parameters
- data: string | ArrayBuffer
  
  Data to write.
Returns void
- Defined in index.ts:2347

Generated using TypeDoc