office-text-extractor-browser/build/lib.d.ts

Fork of office-text-extractor with unreleased changes that include browser support

import { Buffer } from 'buffer/index.js';
/**
 * A method of text extraction.
 */
export type InputType = 'buffer' | 'file' | 'url';
export type ExtractionPayload = {
    type: InputType;
    input: string | Buffer;
};
export type TextExtractionMethod = {
    mimes: string[];
    apply: (_: Buffer) => Promise<string>;
};
/**
 * The text extractor class.
 */
export declare class TextExtractor {
    methods: TextExtractionMethod[];
    /**
     * Registers a new method to this instance of the extractor.
     *
     * @param method The method of text extraction to add.
     * @returns The current instance, for method chaining.
     */
    addMethod: (method: TextExtractionMethod) => this;
    /**
     * Extracts text from the given input.
     *
     * @param payload The input and type of input to extract text from.
     * @returns The extracted text as a simple string.
     */
    extractText: ({ input, type }: ExtractionPayload) => Promise<string>;
}