langchain.js
    Preparing search index...

    Class DirectoryLoader

    A document loader that loads documents from a directory. It extends the BaseDocumentLoader class and implements the load() method.


    const directoryLoader = new DirectoryLoader(
      "src/document_loaders/example_data/",
      {
        ".pdf": (path: string) => new PDFLoader(path),
      },
    );

    const docs = await directoryLoader.load();
    console.log({ docs });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    directoryPath loaders recursive unknown

    Methods

    load imports

    Constructors

    • Parameters

      Returns DirectoryLoader

    Properties

    directoryPath: string
    loaders: LoadersMapping
    recursive: boolean = true
    unknown: UnknownHandling = UnknownHandling.Warn

    Methods

    • Loads the documents from the directory. If a file is a directory and recursive is true, it recursively loads documents from the subdirectory. If a file is a file, it checks if there is a corresponding loader function for the file extension in the loaders mapping. If there is, it loads the documents. If there is no corresponding loader function and unknown is set to Warn, it logs a warning message. If unknown is set to Error, it throws an error.

      Returns Promise<Document[]>

      A promise that resolves to an array of loaded documents.

    • Imports the necessary functions from the node:path and node:fs/promises modules. It is used to dynamically import the functions when needed. If the import fails, it throws an error indicating that the modules failed to load.

      Returns Promise<
          {
              extname: (path: string) => string;
              readdir: {
                  (
                      path: PathLike,
                      options?: null | BufferEncoding | ObjectEncodingOptions & {},
                  ): Promise<string[]>;
                  (
                      path: PathLike,
                      options: {} | "buffer",
                  ): Promise<Buffer<ArrayBufferLike>[]>;
                  (
                      path: PathLike,
                      options?: null | BufferEncoding | ObjectEncodingOptions & {},
                  ): Promise<string[] | Buffer<ArrayBufferLike>[]>;
                  (
                      path: PathLike,
                      options: ObjectEncodingOptions & {},
                  ): Promise<Dirent<string>[]>;
                  (path: PathLike, options: {}): Promise<Dirent<Buffer<ArrayBufferLike>>[]>;
              };
              resolve: (...paths: string[]) => string;
          },
      >

      A promise that resolves to an object containing the imported functions.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods