Class DirectoryLoader

constructor

• new DirectoryLoader(directoryPath, loaders, recursive?, unknown?): DirectoryLoader

• Parameters

  • directoryPath: string

  • loaders: LoadersMapping

  • recursive: boolean = true

  • unknown: UnknownHandling = UnknownHandling.Warn

  Returns DirectoryLoader

directoryPath

loaders

recursive

unknown

load

• load(): Promise<Document<Record<string, any>>[]>

• 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<Record<string, any>>[]>

  A promise that resolves to an array of loaded documents.

Static imports

• imports(): Promise<{
      extname: ((path) => string);
      readdir: {
          (path, options?): Promise<string[]>;
          (path, options): Promise<Buffer[]>;
          (path, options?): Promise<string[] | Buffer[]>;
          (path, options): Promise<Dirent[]>;
      };
      resolve: ((...paths) => string);
  }>

• 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);
      readdir: {
          (path, options?): Promise<string[]>;
          (path, options): Promise<Buffer[]>;
          (path, options?): Promise<string[] | Buffer[]>;
          (path, options): Promise<Dirent[]>;
      };
      resolve: ((...paths) => string);
  }>

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