Interface FileHandle

A file handle returned by file.handle(). Can be used to read and write files in binary mode.

Hierarchy

FileHandle

Index

Methods

offset seekTo seekToEnd read readToEnd write close

Methods

offset

offset(): number
Get the current offset of the file handle.

Returns number
- Defined in index.d.ts:2114

seekTo

seekTo(offset: number): void
Seek to a given offset.
Parameters
- offset: number
  
  The offset to seek to.
Returns void
- Defined in index.d.ts:2119

seekToEnd

seekToEnd(): void
Seek to the end of the file.

Returns void
- Defined in index.d.ts:2123

read

read(length: number): Uint8Array
Read a given number of bytes from the current offset.
Parameters
- length: number
  
  The number of bytes to read.
Returns Uint8Array
- Defined in index.d.ts:2128

readToEnd

readToEnd(): Uint8Array
Read all bytes from the current offset to the end of the file.

Returns Uint8Array
- Defined in index.d.ts:2132

write

write(data: string | number[] | Uint8Array): void
Write data to the file at the current offset.
Parameters
- data: string | number[] | Uint8Array
  
  The data to write.
Returns void
- Defined in index.d.ts:2137

close

close(): void
Close the file handle.

Returns void
- Defined in index.d.ts:2141

Generated using TypeDoc