Class BytesSource

A source over bytes already in memory: a file read up front, or the body of a fetch().

Implements

ByteSource

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

new BytesSource(
bytes: ArrayBuffer | Uint8Array<ArrayBufferLike>,
name?: string,
): BytesSource
Parameters
- bytes: ArrayBuffer | Uint8Array<ArrayBufferLike>
- Optionalname: string
Returns BytesSource
- Defined in reader/src/source.ts:33

Properties

`Optional` `Readonly`name

name?: string

Shown in error messages about this source, e.g. a file path.

Accessors

size

get size(): number
Total size in bytes.

Returns number
Implementation of ByteSource.size
- Defined in reader/src/source.ts:38

Methods

read

read(offset: number, length: number): Promise<Uint8Array<ArrayBufferLike>>
length bytes from offset, fewer only where the source ends. The returned bytes may be a view of the source's own memory, so a caller must not modify them.
Parameters
- offset: number
- length: number
Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of ByteSource.read
- Defined in reader/src/source.ts:42

readNow

readNow(offset: number, length: number): Uint8Array
read() without the promise: bytes in memory need no waiting.
Parameters
- offset: number
- length: number
Returns Uint8Array
- Defined in reader/src/source.ts:47