textstat-ts

TypeScript port of the textstat Python library (https://github.com/textstat/textstat) for calculating various text statistics and readability metrics, with the easy words list adapted from the original implementation.

Note: Syllable counting may differ from the original Python implementation due to the use of the 'syllable' npm package. This may lead to differences in readability metrics.

Features

• Character, word, sentence, and syllable counting
• Readability scores: Flesch Reading Ease, Flesch-Kincaid Grade, SMOG Index
• Difficult word detection
• Support for English text analysis

Installation

npm install textstat-ts

or with Bun:

bun add textstat-ts

Usage

import { TextStatistics, textstat } from 'textstat-ts';

const text = "This is a sample text for analysis.";

// Using the default instance
console.log('Word count:', textstat.lexiconCount(text));
console.log('Flesch Reading Ease:', textstat.fleschReadingEase(text));

// Using a new instance
const stats = new TextStatistics();
console.log('Sentence count:', stats.sentenceCount(text));

API

TextStatistics Class

• charCount(text, ignoreSpaces?): Count characters
• lexiconCount(text, removepunct?, splitContractions?, splitHyphens?): Count words
• syllableCount(text): Count syllables
• sentenceCount(text): Count sentences
• fleschReadingEase(text): Calculate Flesch Reading Ease score
• fleschKincaidGrade(text): Calculate Flesch-Kincaid Grade Level
• smogIndex(text): Calculate SMOG Index
• difficultWords(text, syllableThreshold?, unique?): Count difficult words

License

MIT