Copies files from one location to another, creating all directories required to satisfy the destination path.
The source path
The destination path
Options for the copy, or a filter function
The path to the file you want to copy
The path to the file destination
Creates an empty file, making all folders required to satisfy the given file path.
Path of the file you want to create
Whether the operation should run atomically
Creates an file copy, making all folders required to satisfy the given file path atomically.
Path of the file you want to create
Creates an file copy, making all folders required to satisfy the given file path.
The path to the file you want to copy
The path to the file destination
Whether the operation should run atomically
Creates a file copy atomically, making all folders required to satisfy the given file path.
The path to the file you want to copy
The path to the file destination
Creates a hard file link, making all folders required to satisfy the given file path.
The source path of the file
The destination path of the file
Whether the operation should run atomically
Creates a hard file link, making all folders required to satisfy the given file path atomically.
The source path of the file
The destination path of the file
Creates a soft file link, making all folders required to satisfy the given file path.
The source path of the file
The destination path of the file
Whether the operation should run atomically
Creates a soft file link, making all folders required to satisfy the given file path atomically.
The source path of the file
The destination path of the file
The type of symlink you are creating
Deletes all directories and files within the provided directory.
The directory you wish to empty
Un-Gzips a file
The filename of the output file
The filepath of the archive
If the unzip file should be created atomically
Un-Gzips a file atomically.
The filename of the output file
The filepath of the archive
Gzips a file
The filename of the archive
The filepath of the input file
If the gzip file should be created
Gzips a file atomically.
The filename of the archive
The filepath of the input file
Creates a hard file link atomically.
The source path of the file
The destination path of the file
Recursively makes directories, until the directory passed exists.
The path you wish to make
Options for making the directories
The source path of the file
The destination path of the file
The options for the move
Writes a file to disk, creating all directories needed to meet the filepath provided.
The path to the file you want to create
The data to write to file
Writes a file to disk, creating all directories needed to meet the filepath provided atomically.
The path to the file you want to create
The data to write to file
The write options or the encoding string.
Writes a json file to disk, creating all directories needed to meet the filepath provided.
The path to the file you want to create
The data to write to file
If the operation should be done atomically
Writes a json file to disk, creating all directories needed to meet the filepath provided atomically.
The path to the file you want to create
The data to write to file
The write options or the encoding string.
Checks if a path exists.
The path to check
Reads a file and parses it into a javascript object.
The file path to the json file
Recursively deletes directories and files.
The path to remove
The remove options
Recursively scans a directory, returning a map of stats keyed on the full path to the item.
The path to scan
The options for the scan
Creates a soft file link atomically.
The source path of the file
The destination path of the file
The type of symlink you are creating
Tar/Gzips a directory or array of files.
The filename of the archive
The directory or array of filepaths to .tar.gz
Tar/Gzips a directory or array of files.
The filename of the archive
The directory or array of filepaths to .tar.gz
Extracts files from .tar.gz archives.
The directory to extract to
The archive file
The if the writes should be atomic
Extracts files from .tar.gz archives and writes them atomically.
The directory to extract to
The archive file
The path to the file you want to create
The data to write to file
The write options or the encoding string.
Writes a Javascript Object to file as JSON.
The path to the file you want to create
The javascript object you would like to write to file
Writes a Javascript Object to file as JSON atomically.
The path to the file you want to create
The javascript object you would like to write to file
The options to pass JSON.stringify and writeFile
Generated using TypeDoc
The type of symlink you are creating:
dirfilejunctionfsn/nextra