Skip to content
Class

BlobSource

A source backed by a Blob. Since a File is also a Blob, this is the source to use when reading files off the disk.

Extends: Source

Constructor

ts
constructor(
	blob: Blob,
	options: BlobSourceOptions = {},
): BlobSource;

Creates a new BlobSource backed by the specified Blob.

See BlobSourceOptions.

Events

onread

ts
onread: ((start: number, end: number) => unknown) | null;

Called each time data is retrieved from the source. Will be called with the retrieved range (end exclusive).

Methods

getSizeOrNull()

ts
getSizeOrNull(): Promise<number | null>;

Resolves with the total size of the file in bytes. This function is memoized, meaning only the first call will retrieve the size.

Returns null if the source is unsized.

getSize()

ts
getSize(): Promise<number>;

Resolves with the total size of the file in bytes. This function is memoized, meaning only the first call will retrieve the size.

Throws an error if the source is unsized.

Released under the Mozilla Public License 2.0.