Count syllables in English words
npm install syllable[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Count syllables in an English word.
* What is this?
* When should I use this?
* Install
* Use
* API
* syllable(value)
* CLI
* Types
* Compatibility
* Related
* Contribute
* Security
* Notice
* License
This package estimates how many syllables are in an English word.
Use this when you want to do fun things with natural language, like rhyming,
detecting reading ease, etc.
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
``sh`
npm install syllable
In Deno with [esm.sh][esmsh]:
`js`
import {syllable} from 'https://esm.sh/syllable@5'
In browsers with [esm.sh][esmsh]:
`html`
`js
import {syllable} from 'syllable'
syllable('syllable') // 3
syllable('unicorn') // 3
syllable('hi') // 1
syllable('hihi') // 2
syllable('mmmmmmmmmmmmmmmm') // 1
syllable('wine') // 1
syllable('bottle') // 2
syllable('wine-bottle') // 3
syllable('Åland') // 2
`
This package exports the identifier syllable.
There is no default export.
Get the number of syllables in value.
###### value
Value to check (string, required).
##### Returns
Syllables in value (number).
`txt
Usage: syllable [options]
Count syllables in English words
Options:
-h, --help output usage information
-v, --version output version number
Usage:
Types
This package is fully typed with [TypeScript][].
It exports no additional types.
Compatibility
This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
It also works in Deno and modern browsers.
Related
— formula to detect ease of reading according to the Automated Readability
Index (1967)
*
— list of buzzwords
*
— formula to detect the ease of reading a text according to the Coleman-Liau
index (1975)
*
— map of profane words to a rating of sureness
*
— list of easy American-English words: The New Dale-Chall (1995)
*
— formula to find the grade level according to the (revised) Dale–Chall
Readability Formula (1995)
*
— list of filler words
*
— formula to detect the ease of reading a text according to Flesch Reading
Ease (1975)
*
— formula to detect the grade level of text according to Flesch–Kincaid
Grade Level (1975)
*
— formula to detect the ease of reading a text according to the Gunning fog
index (1952)
*
— list of hedge words
*
— list of profane words
*
— formula to detect the ease of reading a text according to the SMOG
(Simple Measure of Gobbledygook) formula (1969)
*
— list of familiar American-English words (1974)
*
— uses a dictionary, suited for lower reading levels
*
— formula to detect the grade level of text according to the (revised)
Spache Readability Formula (1974)Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
Security
This package is safe.
Notice
Based on the syllable functionality found in [
][stats] (PHP),
in turn inspired by [Lingua::EN::Syllable`][lingua] (Perl).Support for word-breaks, non-ASCII characters, and many fixes added later.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/words/syllable/workflows/main/badge.svg
[build]: https://github.com/words/syllable/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/words/syllable.svg
[coverage]: https://codecov.io/github/words/syllable
[downloads-badge]: https://img.shields.io/npm/dm/syllable.svg
[downloads]: https://www.npmjs.com/package/syllable
[size-badge]: https://img.shields.io/bundlephobia/minzip/syllable.svg
[size]: https://bundlephobia.com/result?p=syllable
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/
[license]: license
[author]: https://wooorm.com
[stats]: https://github.com/DaveChild/Text-Statistics
[lingua]: https://metacpan.org/pod/Lingua::EN::Syllable