#FileHandle.readFile(options?: { encoding?: null | undefined; flag?: OpenMode | undefined; } | null): Promise<Buffer>Asynchronously reads the entire contents of a file.
If options is a string, then it specifies the encoding.
The FileHandle has to support reading.
If one or more filehandle.read() calls are made on a file handle and then a filehandle.readFile() call is made, the data will be read from the current
position till the end of the file. It doesn't always read from the beginning
of the file.
Parameters #
Return Type #
Promise<Buffer>Fulfills upon a successful read with the contents of the file. If no encoding is specified (using options.encoding), the data is returned as a {Buffer} object. Otherwise, the
data will be a string.
#FileHandle.readFile(options: { encoding: BufferEncoding; flag?: OpenMode | undefined; } | BufferEncoding): Promise<string>#FileHandle.readFile(options?: ): Promise<string | Buffer>Asynchronously reads the entire contents of a file. The underlying file will not be closed automatically.
The FileHandle must have been opened for reading.
Parameters #
#options: An object that may contain an optional flag.
If a flag is not provided, it defaults to 'r'.
Return Type #
Promise<string | Buffer>