FileHandle
Value members
Concrete methods
Asynchronously append data to a file, creating the file if it does not exist. The underlying file will not be closed automatically.
The FileHandle
must have been opened for appending.
Asynchronously append data to a file, creating the file if it does not exist. The underlying file will not be closed automatically.
The FileHandle
must have been opened for appending.
- 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'a'
is used.
Asynchronous fchmod(2) - Change permissions of a file.
Asynchronous fchmod(2) - Change permissions of a file.
- Value Params
- 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.
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.
Asynchronously reads data from the file.
The FileHandle
must have been opened for reading.
Asynchronously reads data from the file.
The FileHandle
must have been opened for reading.
- Value Params
- buffer
The buffer that the data will be written to.
- 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. The underlying file will not be closed automatically.
The FileHandle
must have been opened for reading.
Asynchronously reads the entire contents of a file. The underlying file will not be closed automatically.
The FileHandle
must have been opened for reading.
- Value Params
- options
An object that may contain an optional flag. If a flag is not provided, it defaults to
'r'
.
Asynchronously reads the entire contents of a file. The underlying file will not be closed automatically.
The FileHandle
must have been opened for reading.
Asynchronously reads the entire contents of a file. The underlying file will not be closed automatically.
The FileHandle
must have been opened for reading.
- Value Params
- options
An object that may contain an optional flag. If a flag is not provided, it defaults to
'r'
.
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.
Asynchronous ftruncate(2) - Truncate a file to a specified length.
Asynchronous ftruncate(2) - Truncate a file to a specified length.
- Value Params
- len
If not specified, defaults to
0
.
Asynchronously change file timestamps of the file.
Asynchronously change file timestamps of the file.
- 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.
Asynchronously writes string
to the file.
The FileHandle
must have been opened for writing.
It is unsafe to call 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.
The FileHandle
must have been opened for writing.
It is unsafe to call 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.
- 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.
The FileHandle
must have been opened for writing.
Asynchronously writes buffer
to the file.
The FileHandle
must have been opened for writing.
- Value Params
- buffer
The buffer that the data will be written to.
- 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. The underlying file will not be closed automatically.
The FileHandle
must have been opened for writing.
It is unsafe to call 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. The underlying file will not be closed automatically.
The FileHandle
must have been opened for writing.
It is unsafe to call 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.