Class LoaderRegistry

Central registry mapping file extensions to IDocumentLoader implementations.

Built-in loaders (registered automatically)

Extensions Loader
.txt, .csv, .tsv, .json, .yaml, .yml TextLoader
.md, .mdx MarkdownLoader
.html, .htm HtmlLoader
.pdf PdfLoader
.docx DocxLoader

Conditional loaders (registered when available)

Condition Loader
tesseract.js installed factory from createOcrPdfLoader (overrides PDF)
python3 -m docling available factory from createDoclingLoader (overrides PDF + DOCX)

Registering a custom loader

const registry = new LoaderRegistry();
registry.register(new PdfLoader());
const doc = await registry.loadFile('/reports/q3.pdf');

Using loadFile

const registry = new LoaderRegistry();
const doc = await registry.loadFile('/notes/meeting.md');
console.log(doc.metadata.title);

Constructors

constructor

Methods

register getLoader getSupportedExtensions loadFile

Constructors

constructor

Methods

register

  • register(loader): void

  • Register a loader for all extensions it declares.

    If a previously registered loader already handles one of the extension, it is replaced. This makes it trivial to swap in a higher-fidelity implementation for any format.

    Parameters

    Returns void

    Example

    registry.register(new PdfLoader());

getLoader

  • getLoader(extensionOrPath): undefined | IDocumentLoader

  • Retrieve the loader registered for extensionOrPath.

    Both bare extensions (.md, md) and full file paths (/docs/guide.md) are accepted.

    Parameters

    • extensionOrPath: string

      File extension or full path.

    Returns undefined | IDocumentLoader

    The matching IDocumentLoader, or undefined when no loader is registered for the detected extension.

    Example

    const loader = registry.getLoader('.md');
    const loader2 = registry.getLoader('README.md');

getSupportedExtensions

  • getSupportedExtensions(): string[]

  • Return a sorted array of all extensions currently registered.

    Each extension is returned with a leading dot in lower-case, e.g. ['.csv', '.htm', '.html', '.json', '.md', …].

    Returns string[]

    Sorted array of registered extension strings.

loadFile

  • loadFile(filePath, options?): Promise<LoadedDocument>

  • Convenience method: detect format from filePath, find the matching loader, and delegate to its load() method.

    Parameters

    • filePath: string

      Absolute (or resolvable relative) file path.

    • Optional options: LoadOptions

      Optional load hints forwarded to the loader.

    Returns Promise<LoadedDocument>

    A promise resolving to the LoadedDocument.

    Throws

    When no loader is registered for the file's extension.

    Throws

    When the underlying loader's load() throws.

    Example

    const doc = await registry.loadFile('/notes/architecture.md');

Settings

Member Visibility

Theme

On This Page

constructorregistergetLoadergetSupportedExtensionsloadFile