Abstract
Append data to an existing file to the file system, when the directory does not exists it will be created.
path to the file to read
body to write to the file
Optional
options: OutputOptionswrite options
Private
compileAbstract
createFind files and or folders matching the specified glob pattern as an async iterable. If the result is not iterated completely, the search is stopped.
When you need the results as an array, use the Iterable.spreadAsync
method to convert the async interable into an array.
By default the current working directory is used as the base directory for the search.
You can specify multiple glob patterns to match by specifying an array of glob patterns.
When a limit is specified, the search is stopped after the specified number of results is reached.
When a depth is specified, the search does not go deeper than the specified depth.
Glob patterns to match
Optional
options: FindOptionsfind options
Async iterable of matching files and or folders
for await (const file of fs.find('*.ts')) {
console.log(file);
}
Private
normalizeWrite a file to the file system, when the directory does not exists it will be created.
path to the file to read
Optional
body: string | Bufferbody to write to the file
Optional
options: OutputOptionswrite options
Abstract
readAbstract
readAbstract
statGet file statistics; returns undefined when the file does not exists
Path to check
Optional
options: StatsOptionsAbstract
writeWrite a file to the file system, when the directory does not exists it will be created.
path to the file to read
data to write to the file
Optional
options: WriteOptionswrite options
Basic representation of a read-only file system for reading files, checking file existence and reading directory contents.