@pumpkin-plugins/plugin-kit API / files / RandomAccessFile

Interface: RandomAccessFile

Defined in: tools/plugin-kit/src/files.ts:15

A file opened for reads at arbitrary offsets.

Properties

size

readonly size: number

Defined in: tools/plugin-kit/src/files.ts:17

Size in bytes when the file was opened.

Methods

close()

close(): void

Defined in: tools/plugin-kit/src/files.ts:21

Releases the file.

Returns

void

---

read()

read(offset, length): Uint8Array

Defined in: tools/plugin-kit/src/files.ts:19

Reads up to length bytes starting at offset. Returns fewer at the end of the file.

Parameters

offset

number

length

number

Returns

Uint8Array