fsPromisesMod
Type members
Classlikes
Value members
Concrete methods
Asynchronously tests a user's permissions for the file specified by path.
Asynchronously tests a user's permissions for the file specified by path.
- Value Params
- path
A path to a file or directory. If a URL is provided, it must use the
file:
protocol. URL support is experimental.
Asynchronously append data to a file, creating the file if it does not exist.
Asynchronously append data to a file, creating the file if it does not exist.
- Value Params
- data
The data to write. If something other than a
Buffer
orUint8Array
is provided, the value is coerced to a string.- file
A path to a file. If a URL is provided, it must use the
file:
protocol. URL support is experimental. If aFileHandle
is provided, the underlying file will not be closed automatically.- options
Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. If
encoding
is not supplied, the default of'utf8'
is used. Ifmode
is not supplied, the default of0o666
is used. Ifmode
is a string, it is parsed as an octal integer. Ifflag
is not supplied, the default of'a'
is used.
Asynchronous chmod(2) - Change permissions of a file.
Asynchronous chmod(2) - Change permissions of a file.
- Value Params
- mode
A file mode. If a string is passed, it is parsed as an octal integer.
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous chown(2) - Change ownership of a file.
Asynchronous chown(2) - Change ownership of a file.
- Value Params
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronously copies src
to dest
. By default, dest
is overwritten if it already exists.
Node.js makes no guarantees about the atomicity of the copy operation.
If an error occurs after the destination file has been opened for writing, Node.js will attempt
to remove the destination.
Asynchronously copies src
to dest
. By default, dest
is overwritten if it already exists.
Node.js makes no guarantees about the atomicity of the copy operation.
If an error occurs after the destination file has been opened for writing, Node.js will attempt
to remove the destination.
- Value Params
- dest
A path to the destination file.
- flags
An optional integer that specifies the behavior of the copy operation. The only supported flag is
fs.constants.COPYFILE_EXCL
, which causes the copy operation to fail ifdest
already exists.- src
A path to the source file.
Asynchronous fchmod(2) - Change permissions of a file.
Asynchronous fchmod(2) - Change permissions of a file.
- Value Params
- handle
A
FileHandle
.- mode
A file mode. If a string is passed, it is parsed as an octal integer.
Asynchronous fchown(2) - Change ownership of a file.
Asynchronous fchown(2) - Change ownership of a file.
- Value Params
- handle
A
FileHandle
.
Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device.
Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device.
- Value Params
- handle
A
FileHandle
.
Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device.
Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device.
- Value Params
- handle
A
FileHandle
.
Asynchronous ftruncate(2) - Truncate a file to a specified length.
Asynchronous ftruncate(2) - Truncate a file to a specified length.
- Value Params
- handle
A
FileHandle
.- len
If not specified, defaults to
0
.
Asynchronously change file timestamps of the file referenced by the supplied FileHandle
.
Asynchronously change file timestamps of the file referenced by the supplied FileHandle
.
- Value Params
- atime
The last access time. If a string is provided, it will be coerced to number.
- handle
A
FileHandle
.- mtime
The last modified time. If a string is provided, it will be coerced to number.
Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links.
Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links.
- Value Params
- mode
A file mode. If a string is passed, it is parsed as an octal integer.
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links.
Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links.
- Value Params
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file.
Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file.
- Value Params
- existingPath
A path to a file. If a URL is provided, it must use the
file:
protocol.- newPath
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous lstat(2) - Get file status. Does not dereference symbolic links.
Asynchronous lstat(2) - Get file status. Does not dereference symbolic links.
- Value Params
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Changes the access and modification times of a file in the same way as fsPromises.utimes()
,
with the difference that if the path refers to a symbolic link, then the link is not
dereferenced: instead, the timestamps of the symbolic link itself are changed.
Changes the access and modification times of a file in the same way as fsPromises.utimes()
,
with the difference that if the path refers to a symbolic link, then the link is not
dereferenced: instead, the timestamps of the symbolic link itself are changed.
- Value Params
- atime
The last access time. If a string is provided, it will be coerced to number.
- mtime
The last modified time. If a string is provided, it will be coerced to number.
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous mkdir(2) - create a directory.
Asynchronous mkdir(2) - create a directory.
- Value Params
- options
Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to
0o777
.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous mkdir(2) - create a directory.
Asynchronous mkdir(2) - create a directory.
- Value Params
- options
Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to
0o777
.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronously creates a unique temporary directory.
Generates six random characters to be appended behind a required prefix
to create a unique temporary directory.
Asynchronously creates a unique temporary directory.
Generates six random characters to be appended behind a required prefix
to create a unique temporary directory.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.
Asynchronously creates a unique temporary directory.
Generates six random characters to be appended behind a required prefix
to create a unique temporary directory.
Asynchronously creates a unique temporary directory.
Generates six random characters to be appended behind a required prefix
to create a unique temporary directory.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.
Asynchronous open(2) - open and possibly create a file.
Asynchronous open(2) - open and possibly create a file.
- Value Params
- mode
A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to
0o666
.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronously reads data from the file referenced by the supplied FileHandle
.
Asynchronously reads data from the file referenced by the supplied FileHandle
.
- Value Params
- buffer
The buffer that the data will be written to.
- handle
A
FileHandle
.- length
The number of bytes to read.
- offset
The offset in the buffer at which to start writing.
- position
The offset from the beginning of the file from which data should be read. If
null
, data will be read from the current position.
Asynchronously reads the entire contents of a file.
Asynchronously reads the entire contents of a file.
- Value Params
- options
An object that may contain an optional flag. If a flag is not provided, it defaults to
'r'
.- path
A path to a file. If a URL is provided, it must use the
file:
protocol. If aFileHandle
is provided, the underlying file will not be closed automatically.
Asynchronously reads the entire contents of a file.
Asynchronously reads the entire contents of a file.
- Value Params
- options
An object that may contain an optional flag. If a flag is not provided, it defaults to
'r'
.- path
A path to a file. If a URL is provided, it must use the
file:
protocol. If aFileHandle
is provided, the underlying file will not be closed automatically.
Asynchronous readdir(3) - read a directory.
Asynchronous readdir(3) - read a directory.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous readdir(3) - read a directory.
Asynchronous readdir(3) - read a directory.
- Value Params
- options
If called with
withFileTypes: true
the result data will be an array of Dirent.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous readdir(3) - read a directory.
Asynchronous readdir(3) - read a directory.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous readlink(2) - read value of a symbolic link.
Asynchronous readlink(2) - read value of a symbolic link.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous readlink(2) - read value of a symbolic link.
Asynchronous readlink(2) - read value of a symbolic link.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous realpath(3) - return the canonicalized absolute pathname.
Asynchronous realpath(3) - return the canonicalized absolute pathname.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous realpath(3) - return the canonicalized absolute pathname.
Asynchronous realpath(3) - return the canonicalized absolute pathname.
- Value Params
- options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided,
'utf8'
is used.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous rename(2) - Change the name or location of a file or directory.
Asynchronous rename(2) - Change the name or location of a file or directory.
- Value Params
- newPath
A path to a file. If a URL is provided, it must use the
file:
protocol. URL support is experimental.- oldPath
A path to a file. If a URL is provided, it must use the
file:
protocol. URL support is experimental.
Asynchronously removes files and directories (modeled on the standard POSIX rm
utility).
Asynchronously removes files and directories (modeled on the standard POSIX rm
utility).
Asynchronous rmdir(2) - delete a directory.
Asynchronous rmdir(2) - delete a directory.
- Value Params
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous stat(2) - Get file status.
Asynchronous stat(2) - Get file status.
- Value Params
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous symlink(2) - Create a new symbolic link to an existing file.
Asynchronous symlink(2) - Create a new symbolic link to an existing file.
- Value Params
- path
A path to the new symlink. If a URL is provided, it must use the
file:
protocol.- target
A path to an existing file. If a URL is provided, it must use the
file:
protocol.- type
May be set to
'dir'
,'file'
, or'junction'
(default is'file'
) and is only available on Windows (ignored on other platforms). When using'junction'
, thetarget
argument will automatically be normalized to an absolute path.
Asynchronous truncate(2) - Truncate a file to a specified length.
Asynchronous truncate(2) - Truncate a file to a specified length.
- Value Params
- len
If not specified, defaults to
0
.- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronous unlink(2) - delete a name and possibly the file it refers to.
Asynchronous unlink(2) - delete a name and possibly the file it refers to.
- Value Params
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Asynchronously change file timestamps of the file referenced by the supplied path.
Asynchronously change file timestamps of the file referenced by the supplied path.
- Value Params
- atime
The last access time. If a string is provided, it will be coerced to number.
- mtime
The last modified time. If a string is provided, it will be coerced to number.
- path
A path to a file. If a URL is provided, it must use the
file:
protocol.
Watch for changes on filename
, where filename
is either a file or a directory, returning an FSWatcher
.
Watch for changes on filename
, where filename
is either a file or a directory, returning an FSWatcher
.
- Value Params
- filename
A path to a file or directory. If a URL is provided, it must use the
file:
protocol.- options
Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. If
encoding
is not supplied, the default of'utf8'
is used. Ifpersistent
is not supplied, the default oftrue
is used. Ifrecursive
is not supplied, the default offalse
is used.
Watch for changes on filename
, where filename
is either a file or a directory, returning an FSWatcher
.
Watch for changes on filename
, where filename
is either a file or a directory, returning an FSWatcher
.
- Value Params
- filename
A path to a file or directory. If a URL is provided, it must use the
file:
protocol.- options
Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. If
encoding
is not supplied, the default of'utf8'
is used. Ifpersistent
is not supplied, the default oftrue
is used. Ifrecursive
is not supplied, the default offalse
is used.
Watch for changes on filename
, where filename
is either a file or a directory, returning an FSWatcher
.
Watch for changes on filename
, where filename
is either a file or a directory, returning an FSWatcher
.
- Value Params
- filename
A path to a file or directory. If a URL is provided, it must use the
file:
protocol.- options
Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. If
encoding
is not supplied, the default of'utf8'
is used. Ifpersistent
is not supplied, the default oftrue
is used. Ifrecursive
is not supplied, the default offalse
is used.
Asynchronously writes string
to the file referenced by the supplied FileHandle
.
It is unsafe to call fsPromises.write()
multiple times on the same file without waiting for the Promise
to be resolved (or rejected). For this scenario, fs.createWriteStream
is strongly recommended.
Asynchronously writes string
to the file referenced by the supplied FileHandle
.
It is unsafe to call fsPromises.write()
multiple times on the same file without waiting for the Promise
to be resolved (or rejected). For this scenario, fs.createWriteStream
is strongly recommended.
- Value Params
- encoding
The expected string encoding.
- handle
A
FileHandle
.- position
The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
- string
A string to write.
Asynchronously writes buffer
to the file referenced by the supplied FileHandle
.
It is unsafe to call fsPromises.write()
multiple times on the same file without waiting for the Promise
to be resolved (or rejected). For this scenario, fs.createWriteStream
is strongly recommended.
Asynchronously writes buffer
to the file referenced by the supplied FileHandle
.
It is unsafe to call fsPromises.write()
multiple times on the same file without waiting for the Promise
to be resolved (or rejected). For this scenario, fs.createWriteStream
is strongly recommended.
- Value Params
- buffer
The buffer that the data will be written to.
- handle
A
FileHandle
.- length
The number of bytes to write. If not supplied, defaults to
buffer.length - offset
.- offset
The part of the buffer to be written. If not supplied, defaults to
0
.- position
The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
Asynchronously writes data to a file, replacing the file if it already exists.
It is unsafe to call fsPromises.writeFile()
multiple times on the same file without waiting for the Promise
to be resolved (or rejected).
Asynchronously writes data to a file, replacing the file if it already exists.
It is unsafe to call fsPromises.writeFile()
multiple times on the same file without waiting for the Promise
to be resolved (or rejected).
- Value Params
- data
The data to write. If something other than a
Buffer
orUint8Array
is provided, the value is coerced to a string.- options
Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. If
encoding
is not supplied, the default of'utf8'
is used. Ifmode
is not supplied, the default of0o666
is used. Ifmode
is a string, it is parsed as an octal integer. Ifflag
is not supplied, the default of'w'
is used.- path
A path to a file. If a URL is provided, it must use the
file:
protocol. URL support is experimental. If aFileHandle
is provided, the underlying file will not be closed automatically.