Wrapper of delete operation in filesystem.
A path to unlink or delete from filesystem.
Optional callback called after delete operation is finished.
A promise of the delete operation.
Create a stream of file at given path.
Path to file
Stream object of file
Wrapper to append file with data.
Path to write file.
Plain string to append to file, or Buffer instance, or serializable (as JSON) object.
Optional charset of data. Default is "utf-8".
Wrapper to append file with data.
Path to write file.
You can provide an async iterable object to write on demand or a synchronous one to group inputs before write.
Optional charset of data. Default is "utf-8".
Wrapper to check if a path already exists in filesystem.
Path to check avaiability.
Optional callback to run after async check.
A promise of existance check.
Wrapper to copy a file or a directory to a given directory.
Path to a file or directory.
Path of new directory to copy (input will be put inside this path).
Optional new name of file or directory.
Wrapper of delete operation in filesystem.
A path to unlink or delete from filesystem.
Optional callback called after delete operation is finished.
A promise of the delete operation.
Wrapper to check if a path does not exist in filesystem. Is the oposite of exists() method.
Path to check unavaiability.
A promise of non-existance check.
Wrapper to check if a path does not exist in filesystem. Is the oposite of exists() method.
Path to check unavaiability.
Optional access mode flags to check unavaiability (see: {@link fs.constants NodeJS.fs.constants}).
A promise of non-existance check.
Wrapper to check if a path does not exist in filesystem. Is the oposite of exists() method.
Paths to check in a row.
A promise of non-existance check.
Create a Duplex (both Readable and Writable) stream of file at given path.
Path to file
Optional {@link Stream.DuplexOptions node:stream.DuplexOptions} object to customize stream
Duplex stream object of file
Wrapper to check if a path already exists in filesystem.
Path to check avaiability.
A promise of existance check.
Wrapper to check if a path already exists in filesystem.
Path to check avaiability.
Optional access mode flags to check avaiability (see: {@link fs.constants NodeJS.fs.constants}).
A promise of existance check.
Wrapper to check if a path already exists in filesystem.
paths to check in a row
A promise of existance check.
Create a stream of file at given path.
Path to file
Stream object of file
Wrapper to read file (load all data in string, intended for small files like config. files).
Path to read file.
Optional encoding of string. Default is "utf-8".
The string content of the file.
Wrapper to read file (load all data into a single buffer, intended for small binary files).
Path to read file.
The array with the binary buffers streamed of the file.
Wrapper to read file (load all data into array of buffers, intended for small binary files).
Path to read file.
The array with the binary buffers streamed of the file.
Wrapper to read file as JSON (load all data into a single buffer, intended for small binary files).
Path to read JSON file (be careful to do not load huge JSONs, as it will load entire JSON file in string before parsing).
file encoding to parse, default is "utf-8".
A function that transforms the results. This function is called for each member of the object. If a member contains nested objects, the nested objects are transformed before the parent object is.
Assynchronously reads given file at default storage. Supports Callback syntax and Promise syntax.
path to the file in default storage.
optional callback to handle output and error. If not provided it resolve as a Promise
Checks if given path corresponds to a directory
Checks if given path corresponds to a file
Wrapper to list directory contents
Path to list
Wrapper function to directory creation in filesystem (recursive or not).
Path to search in filesystem.
Filesystem options for mkdir operation.
Optional callback for mkdir async operation.
A promise of mkdir operation.
Wrapper to move a file, or directory.
Current path.
New path.
Optional renaming.
Wrapper for opening attempts to a path, be file or directory.
Path to open a file or list directory.
Optional callback called if path leads to a file.
Optional callback called if path leads to a directory.
Optional encoding for files, default utf-8.
Wrapper to write in a given filename.
Path to write file.
Plain string to insert into file, or Buffer instance, or serializable (as JSON) object.
Optional charset of data. Default is "utf-8".
Wrapper to write in a given filename.
Path to write file.
You can provide an async iterable object to write on demand or a synchronous one to group inputs before write.
Optional charset of data. Default is "utf-8".
Creates an Writable stream to transform/process chunk data from a file, piping'em, and returns the writed stream.
path to the file in default storage.
options to setup the write stream.
optional callback to error handling (default console.error output stream).
Reads given file asynchronously on-demand and pipe out to given writable stream
path to the file in default storage
writable stream to output retrieved data
Create a readable stream of file at given path.
Path to file
Optional {@link Stream.ReadableOptions node:stream.ReadableOptions} object to customize stream
Optional settings for underlying fs stream.
Readable stream object of file
Wrapper to rename a file, or directory.
Current path.
New name to file or directory.
Wrapper to retrieve stats of a given path
Path to retrieve stats.
File path to write in filesystem (if parent directory does not exist, create before write the file).
File data as ArrayBuffer.
Chunk size of file.
Optional callback called when write operation is finished.
A promise of the write operation.
Wrapper to write files asynchronously in filesystem.
Path of the file to write in filesystem (overrides if already exists).
File data, as ArrayBuffer or UInt8Array.
Optional encoding of data, default binary.
Create a writable stream of file at given path.
Path to file
Optional {@link Stream.WritableOptions node:stream.WritableOptions} object to customize stream
Optional settings for underlying fs stream.
Writable stream object of file
Generated using TypeDoc
A filesystem wrapper class