Interface ReadFileSystem

Interface for a file system that can create readable sources. Implementations exist for various backends (URL, Node FS, Zip, Memory).

interface ReadFileSystem {
    createSource(
        filename: string,
        progress?: ProgressCallback,
    ): Promise<ReadSource>;
}

Implemented by

Index

Methods

Methods

createSource

createSource(filename: string, progress?: ProgressCallback): Promise<ReadSource>
Create a readable source for the given path/identifier.
Parameters
- filename: string
  Path or identifier for the resource
- Optionalprogress: ProgressCallback
  Optional callback for progress reporting
Returns Promise<ReadSource>
Promise resolving to a ReadSource
- Defined in io/read/file-system.ts:116