Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 1.34 KB

README.md

File metadata and controls

30 lines (25 loc) · 1.34 KB

Syllabificate Build Status

Syllable counts and polysyllable counts in Javascript. Try the demo here!

Syllable counts are an important part of calculating many readability metrics, such as the Flesch-Kincaid score and the SMOG grade. Syllabificate was created to facilitate faster and more accurate measurements for these calculations.

Note: Syllabificate is an English language syllable counter. It may not be accurate in other languages.

Installation (Node)

npm install syllabificate

Usage

const syl = require('syllabificate');

countSyllables(string)

Returns the total number of syllables in a string.

syl.countSyllables("Electric slide."); //4

countPolys(string)

Returns the total number of polysyllables (words with 3 or more syllables) in a string.

syl.countPolys("Electric slide."); //1

countSyllablesAndPolys(string)

Returns both the total number of syllables and the total number of polysyllables as an array: [syllables, polysyllables]. This can be useful if you are calculating multiple metrics.

syl.countSyllablesAndPolys("Electric slide."); //[4, 1]