File delimiter
Linux OS identifier
Mac OS identifier
Windows OS identifier
UTF8 identifier
Create a directory if it does not yet exist synchronously.
directory to create
Create all needed directories for an input directory in the form of: first/second/third where first will contain director second and second will contain directory third
directory to create all sub directories for
Create all necessary directories for a fully qualified file and its path, for example, if filePath = oneDir/twoDir/threeDir/file.txt, oneDir, twoDir, and threeDir will be created.
[description]
Create a file
file to create
Create a Node.js Readable stream from a file
the file from which to create a read stream
Buffer - the content of the file
Create a symbolic link to a directory. If the symbolic link already exists, re-create it with the specified target directory.
the path new symbolic link to be created
the path the existing directory that we will link to
Create a Node.js Readable stream from a file
the file from which to create a read stream
Buffer - the content of the file
Delete a directory
Recursively delete all files and subdirectories of the specified directory. Ensure that we do not follow a symlink. Just delete the link.
Delete a file
Delete a symbolic link.
the path to a symbolic link to be deleted
Wraps fs.existsSync so that we dont have to import fs unnecessarily
file to validate existence against
true if file exists
Get default text editor for a given operating system
Set file access permissions so that only the current user will have access to the file. On windows, it means "full control" for the current user. On posix, it means read & write access for the current user. Obviously, the current user must have permission to change permissions on the specified file.
file name for which we modify access.
Return whether input file is a directory or file
file path
Uses the fs-extra package to create a directory (and all subdirectories)
the directory (do not include a file name)
Take an extension and prefix with a '.' identifier
extension to normalize
Process a string so that its line endings are operating system appropriate before you save it to disk (basically, if the user is on Windows, change \n to \r\n)
original input
last byte of previous input, if it is being processed in chunks
Wraps fs.readFileSync so that we dont have to import fs unnecessarily or specify encoding.
file to read
remove Windows line endings (\r\n) in favor of \n
should the file be read in binary mode? If so, normalizeNewLines is ignored. If false, the file will be read in UTF-8 encoding
Buffer - the content of the file
Write a file
file to create
content to write
Create a file asynchronously
file to create
content to write in the file
[description]
Write an object to a file and set consistent formatting on the serialized JSON object.
file to create
object to serialize
Generated using TypeDoc
This class will handle common sequences of node I/O and issue messages / throw errors as neccessary.