Interface IDocumentLoader

Unified interface for all document loaders in the AgentOS ingestion pipeline.

Implementations handle a specific set of file extensions and are responsible for:

  1. Reading raw bytes from a file path or in-memory Buffer.
  2. Extracting plain-text content and structured metadata.
  3. Returning a LoadedDocument ready for downstream chunking.

Example

const loader: IDocumentLoader = new MarkdownLoader();
if (loader.canLoad('README.md')) {
  const doc = await loader.load('README.md');
  console.log(doc.metadata.title);
}
interface IDocumentLoader {
    supportedExtensions: string[];
    load(source, options?): Promise<LoadedDocument>;
    canLoad(source): boolean;
}

Implemented by

Methods

load canLoad

Properties

supportedExtensions

Methods

load

  • load(source, options?): Promise<LoadedDocument>

  • Parses source and returns a normalised LoadedDocument.

    When source is a string the loader treats it as an absolute (or resolvable) file path and reads the file from disk. When source is a Buffer the loader parses the bytes directly and derives as much metadata as possible from the buffer content alone.

    Parameters

    • source: string | Buffer<ArrayBufferLike>

      Absolute file path OR raw document bytes.

    • Optional options: LoadOptions

      Optional hints such as a format override.

    Returns Promise<LoadedDocument>

    A promise resolving to the fully-populated LoadedDocument.

    Throws

    When the file cannot be read or the format is not parsable.

canLoad

  • canLoad(source): boolean

  • Returns true when this loader is capable of handling source.

    For string sources the check is purely extension-based. For Buffer sources the loader may inspect magic bytes when relevant.

    Parameters

    • source: string | Buffer<ArrayBufferLike>

      Absolute file path or raw bytes.

    Returns boolean

Properties

Readonly supportedExtensions

supportedExtensions: string[]

File extensions this loader handles, each with a leading dot.

Used by LoaderRegistry to route file paths to the correct loader.

Example

['.md', '.mdx']

Settings

Member Visibility

Theme

On This Page

loadcanLoadsupportedExtensions