Class

FilePathSource

A source backed by a path to a file. Intended for server-side usage in Node, Bun, or Deno.

Make sure to call .dispose() on the corresponding Input when done to explicitly free the internal file handle acquired by this source.

Extends: Source

Constructor

constructor(
	filePath: string,
	options: BlobSourceOptions = {},
): FilePathSource;

Creates a new FilePathSource backed by the file at the specified file path.

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).

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(): 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.