Interface FileSystem

Hierarchy

FileSystem

Index

Methods

existsAsFile readFileTextIfExists writeFileText

Methods

existsAsFile

existsAsFile(filePath: string): Promise<boolean>
Determines if the file exists.

Returns
- true if the file system item at the path exists and it is a file.
- false if there is no the file system item at the path.
Throws
- Error if the file system item at the path exists but is is of different type e.g. a directory.
- Error including the path and the method name if some other file system error happended.
Parameters
- filePath: string
Returns Promise<boolean>

readFileTextIfExists

readFileTextIfExists(filePath: string): Promise<null | string>
Reads file text using UTF-8 encoding if the file exists.

Returns
null if the file does not exist.
Parameters
- filePath: string
Returns Promise<null | string>

writeFileText

writeFileText(filePath: string, contents: string): Promise<void>
If the file already exists, then it is overwritten. Also creates directories on the file path if they do not exist.
Parameters
- filePath: string
- contents: string
Returns Promise<void>

Generated using TypeDoc