@types/word-extractor/README.md

TypeScript definitions for word-extractor

# Installation
> `npm install --save @types/word-extractor`

# Summary
This package contains type definitions for word-extractor (https://github.com/morungos/node-word-extractor).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/word-extractor.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/word-extractor/index.d.ts)
````ts
/// <reference types="node" />

declare class WordExtractor {
    extract(documentPath: string | Buffer): Promise<WordExtractor.Document>;
}

export = WordExtractor;

declare namespace WordExtractor {
    class Document {
        getBody(): string;
        getFootnotes(): string;
        getHeaders(options?: { includeFooters?: boolean | undefined }): string;
        getFooters(): string;
        getAnnotations(): string;
        getTextboxes(
            options?: { includeHeadersAndFooters?: boolean | undefined; includeBody?: boolean | undefined },
        ): string;
        getEndnotes(): string;
    }
}

````

### Additional Details
 * Last updated: Fri, 25 Oct 2024 09:34:05 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Rodrigo Saboya](https://github.com/saboya).