# @types/word-extractor

> TypeScript definitions for word-extractor

Latest version **1.0.6** (published 2024-10-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/word-extractor
pnpm add @types/word-extractor
yarn add @types/word-extractor
bun add @types/word-extractor
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2024-10-25 |
| First published | 2019-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/word-extractor
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/word-extractor
- npm.io page: https://npm.io/package/@types/word-extractor

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 1.0.6 (latest) — 2024-10-25
- 1.0.5 (ts4.5) — 2023-11-07
- 1.0.2 (ts4.4) — 2023-05-29
- 1.0.1 (ts4.1) — 2021-07-02
- 0.3.0 (ts3.0) — 2019-02-22
- 1.0.4 — 2023-10-18
- 1.0.3 — 2023-09-25
- 1.0.0 — 2021-06-13

## README

# 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).

---
_Source: https://npm.io/package/@types/word-extractor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._