Class LocalFileReadHandle

Hierarchy (view full)

LocalFileHandle
- LocalFileReadHandle

Index

Properties

Methods

close isOpen readBinary readLine readToEnd reset

Properties

info

info: LocalFileInfo

Contains information about the file.

Methods

close

close(): Promise<void>
Closes the file. This makes it available for other programs to use.

Returns Promise<void>
Inherited from LocalFileHandle.close

isOpen

isOpen(): Promise<boolean>
Checks whether the file is still available.

Returns Promise<boolean>
Inherited from LocalFileHandle.isOpen

readBinary

readBinary(): Promise<ArrayBuffer>
Reads the entire contents of the file from the beginning to the end regardless of the read position in the file. After reading, the read position is set to the beginning of the file.

Returns Promise<ArrayBuffer>
An array buffer containing the raw binary data of the file.

readLine

readLine(): Promise<null | string>
Reads the next line of text from the file. Advances the read position to the end of that line. Use readBinary to read binary data.

Returns Promise<null | string>
The next line of text from the file, or null if the read position is at the end of the file.

readToEnd

readToEnd(): Promise<string>
Reads the contents of the file as text from the current read position to the end. This method sets the read position of the file to the beginning. Use readBinary to read binary data.

Returns Promise<string>
The remainder of the file, or an empty string if the read position is at the end of the file.

reset

reset(): Promise<void>
Resets the file pointer back to the beginning of the file.

Returns Promise<void>