Formula to detect the ease of reading a text according to Flesch Reading Ease (1975)
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig Rewrite module Jul 24, 2016
.gitignore Refactor code-style Aug 30, 2018
.npmrc Add `.npmrc` Aug 30, 2018
.prettierignore Refactor code-style Aug 30, 2018
.travis.yml Update Node in Travis Aug 30, 2018
index.js Refactor code-style Aug 30, 2018
license Move `LICENCE` > `license` Aug 30, 2018
package.json 1.0.3 Aug 30, 2018
readme.md Refactor code-style Aug 30, 2018
test.js Refactor code-style Aug 30, 2018

readme.md

flesch Build Status Coverage Status

Formula to detect the grade level of text according to the Flesch Reading Ease.

See syllable for detecting syllables.

Installation

npm:

npm install flesch

Usage

var flesch = require('flesch')

// For “The cat sat on the mat” (1 sentence, 6 words, 6 syllables).
flesch({sentence: 1, word: 6, syllable: 6}) // => 116.14500...

// For “The Australian platypus is seemingly a hybrid of mammal and reptilian
// creature.” (1 sentence, 12 words, 23 syllables).
flesch({sentence: 1, word: 12, syllable: 23}) // => 32.50499...

API

flesch(counts)

Given an object containing the number of words (word), the number of sentences (sentence), and the number of syllables (syllable) in a document, returns the reading ease associated with the document.

Returned values are 120 (every sentence consisting of only two one-syllable words), or lower (including negative values).

The values have the following semantics:

Score Semantics
90.0 – 100.0 Easily understood by an average 11-year-old student
60.0 – 70.0 Easily understood by 13- to 15-year-old students
0.0 – 30.0 Best understood by university graduates

Related

License

MIT © Titus Wormer