method promises.FileHandle.read
Jump to headingFileHandle.read<T extends ArrayBufferView>(buffer: T,offset?: number | null,length?: number | null,position?: number | null,): Promise<FileReadResult<T>>Reads data from the file and stores that in the given buffer.
If the file is not modified concurrently, the end-of-file is reached when the number of bytes read is zero.
Type Parameters Jump to heading
Jump to headingT extends ArrayBufferViewParameters Jump to heading
Jump to headingbuffer: TA buffer that will be filled with the file data read.
optional
Jump to headingoffset: number | nullThe location in the buffer at which to start filling.
optional
Jump to headinglength: number | nullThe number of bytes to read.
optional
Jump to headingposition: number | nullThe location where to begin reading data from the file. If null, data will be read from the current file position, and the position will be updated. If position is an
integer, the current file position will remain unchanged.
Return Type Jump to heading
Promise<FileReadResult<T>>Fulfills upon success with an object with two properties:
Jump to headingFileHandle.read<T extends ArrayBufferView = Buffer>(options?: FileReadOptions<T>): Promise<FileReadResult<T>>Type Parameters Jump to heading
Jump to headingT extends ArrayBufferView = BufferParameters Jump to heading
optional
Jump to headingoptions: FileReadOptions<T>Return Type Jump to heading
Promise<FileReadResult<T>>