langchain.js
    Preparing search index...

    Abstract class that extends the BaseDocumentLoader class. It represents a document loader that loads documents from a buffer. The load() method is implemented to read the buffer contents and metadata based on the type of filePathOrBlob, and then calls the parse() method to parse the buffer and return the documents.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • filePathOrBlob: string | Blob

      Returns BufferLoader

    Properties

    filePathOrBlob: string | Blob

    Methods

    • Method that reads the buffer contents and metadata based on the type of filePathOrBlob, and then calls the parse() method to parse the buffer and return the documents.

      Returns Promise<Document[]>

      Promise that resolves with an array of Document objects.

    • Abstract method that needs to be implemented by subclasses. It is used to parse the buffer and return the documents.

      Parameters

      • raw: Buffer

        The buffer to be parsed.

      • metadata: Document

        Metadata of the document.

      Returns Promise<Document[]>

      Promise that resolves with an array of Document objects.

    • Static method that imports the readFile function from the fs/promises module in Node.js. It is used to dynamically import the function when needed. If the import fails, it throws an error indicating that the fs/promises module is not available in the current environment.

      Returns Promise<
          {
              readFile: {
                  (
                      path: PathLike | FileHandle,
                      options?: null | {} & Abortable,
                  ): Promise<Buffer<ArrayBufferLike>>;
                  (
                      path: PathLike | FileHandle,
                      options: {} & Abortable | BufferEncoding,
                  ): Promise<string>;
                  (
                      path: PathLike | FileHandle,
                      options?: null | BufferEncoding | ObjectEncodingOptions & Abortable & {},
                  ): Promise<string | Buffer<ArrayBufferLike>>;
              };
          },
      >

      Promise that resolves with an object containing the readFile function.