Class DocxLoader

A class that extends the BufferLoader class. It represents a document loader that loads documents from DOCX files. It has a constructor that takes a filePathOrBlob parameter representing the path to the word file or a Blob object, and an optional options parameter of type DocxLoaderOptions

Hierarchy

  • BufferLoader
    • DocxLoader

Constructors

constructor

Properties

filePathOrBlob options

Methods

load loadAndSplit parse imports

Constructors

constructor

Properties

filePathOrBlob

filePathOrBlob: string | Blob

Protectedoptions

options: DocxLoaderOptions = ...

Methods

load

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

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

    Promise that resolves with an array of Document objects.

loadAndSplit

  • loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>

  • Parameters

    • Optionalsplitter: BaseDocumentTransformer<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[]>

    Returns Promise<Document<Record<string, any>>[]>

    A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.

    Deprecated

    Use this.load() and splitter.splitDocuments() individually. Loads the documents and splits them using a specified text splitter.

parse

  • parse(raw, metadata): Promise<Document<Record<string, any>>[]>

  • A method that takes a raw buffer and metadata as parameters and returns a promise that resolves to an array of Document instances. It uses the extractRawText function from the mammoth module or extract method from the word-extractor module to extract the raw text content from the buffer. If the extracted text content is empty, it returns an empty array. Otherwise, it creates a new Document instance with the extracted text content and the provided metadata, and returns it as an array.

    Parameters

    • raw: Buffer<ArrayBufferLike>

      The raw buffer from which to extract text content.

    • metadata: Record<string, any>

      The metadata to be associated with the created Document instance.

    Returns Promise<Document<Record<string, any>>[]>

    A promise that resolves to an array of Document instances.

Staticimports

  • imports(): Promise<{
        readFile: {
            (path: PathLike | FileHandle, options?: null | {
                encoding?: null;
                flag?: OpenMode;
            } & Abortable): Promise<Buffer>;
            (path: PathLike | FileHandle, options: BufferEncoding | {
                encoding: BufferEncoding;
                flag?: OpenMode | undefined;
            } & Abortable): Promise<string>;
            (path: PathLike | FileHandle, options?: null | BufferEncoding | ObjectEncodingOptions & Abortable & {
                flag?: OpenMode | undefined;
            }): Promise<string | Buffer>;
        };
    }>

  • 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 | {
                encoding?: null;
                flag?: OpenMode;
            } & Abortable): Promise<Buffer>;
            (path: PathLike | FileHandle, options: BufferEncoding | {
                encoding: BufferEncoding;
                flag?: OpenMode | undefined;
            } & Abortable): Promise<string>;
            (path: PathLike | FileHandle, options?: null | BufferEncoding | ObjectEncodingOptions & Abortable & {
                flag?: OpenMode | undefined;
            }): Promise<string | Buffer>;
        };
    }>

    Promise that resolves with an object containing the readFile function.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods