# flesch-kincaid-calc

> A library for calculating the Flesch-Kincaid grade level and reading ease.

Latest version **1.0.1** (published 2021-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install flesch-kincaid-calc
pnpm add flesch-kincaid-calc
yarn add flesch-kincaid-calc
bun add flesch-kincaid-calc
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-09-28 |
| First published | 2021-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ken Bimmel |
| Maintainers | ken-bimmel |
| Keywords | readability, flesch, kincaid, flesch-kincaid, grade, level, reading, ease |

## Links

- npm: https://www.npmjs.com/package/flesch-kincaid-calc
- Repository: https://github.com/ken-bimmel/flesch-kincaid
- Homepage: https://github.com/ken-bimmel/flesch-kincaid#flesch-kincaid-calc
- Issues: https://github.com/ken-bimmel/flesch-kincaid/issues
- npm.io page: https://npm.io/package/flesch-kincaid-calc

## Dependencies (1)

- [decimal.js](https://npm.io/package/decimal.js.md) ^10.3.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-09-28
- 1.0.0 — 2021-09-28

## README

# Flesch-Kincaid Calc

This simple library provides two functions, `getGradeLevel` and `getReadingEase`, to allow you to calculate the grade level and reading ease using the [Flesch-Kincaid method](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests).

Run the examples with `node example.js`.

## Usage

```js
const fk = require("flesch-kincaid-calc");

const THREE_LITTLE_PIGS = `Once upon a time there was an old mother pig who had three little pigs and not enough food to feed them. So when they were old enough, she sent them out into the world to seek their fortunes. The first little pig was very lazy. He didn't want to work at all and he built his house out of straw. The second little pig worked a little bit harder but he was somewhat lazy too and he built his house out of sticks. Then, they sang and danced and played together the rest of the day.`

fk.getGradeLevel(THREE_LITTLE_PIGS); //4.947989690721649485
fk.getReadingEase(THREE_LITTLE_PIGS); //88.38253436426116838
```

---
_Source: https://npm.io/package/flesch-kincaid-calc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._