# @types/estimated-read-time

> TypeScript definitions for estimated-read-time

Latest version **1.2.2** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/estimated-read-time
pnpm add @types/estimated-read-time
yarn add @types/estimated-read-time
bun add @types/estimated-read-time
```

## Health

**Score 45/100 (D)** — status: abandoned.

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

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2023-11-07 |
| First published | 2021-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51442 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.2.2 (latest) — 2023-11-07
- 1.2.0 (ts3.6) — 2021-07-29
- 1.2.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/estimated-read-time`

# Summary
This package contains type definitions for estimated-read-time (https://github.com/karthik512/estimated-read-time).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/estimated-read-time.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/estimated-read-time/index.d.ts)
````ts
export interface TextOptions {
    MIN_WORD_LEN?: number;
    WPM?: number;
    IS_TECHNICAL_DOC?: boolean;
    TECH_DIFFICULTY?: 1 | 2 | 3 | 4 | 5;
    TOTAL_WORDS?: number;
    TOTAL_SECONDS?: number;
}

export interface TextResult {
    // eslint-disable-next-line camelcase
    word_count: number;
    seconds: number;
}

export function text(content: string, options?: TextOptions): TextResult;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: none

# Credits
These definitions were written by [Stepan Zinchenko](https://github.com/stepanzin).

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