kotlin-node/node.fs/FileHandle/readFileAsync

readFileAsync

abstract fun readFileAsync(options: FileHandleReadFileBufferAsyncOptions? = definedExternally): Promise<Buffer>(source)

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.

Since

v10.0.0

Return

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.

abstract fun readFileAsync(options: FileHandleReadFileStringAsyncOptions): Promise<String>(source)
abstract fun readFileAsync(options: BufferEncoding): Promise<String>(source)
abstract fun readFileAsync(): Promise<Any>(source)
abstract fun readFileAsync(options: FileHandleReadFileAsyncOptions? = definedExternally): Promise<Any>(source)
abstract fun readFileAsync(options: BufferEncoding? = definedExternally): Promise<Any>(source)

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'.