@lunarisapp/readability v1.0.1

Lunaris Readability

A library for calculating text readability scores based on popular algorithms & formulas, inspired by textstat.

!TIP See also:

• @lunarisapp/language for core linguistic breakdown: vowels, consonants, words, and sentences.
• @lunarisapp/stats for text statistics (e.g. word count, sentence count, etc.).
• @lunarisapp/hyphen for word hyphenation.

Features

• Browser & Node.js support
• Multi-language support
• Pure formulas for direct usage
• Caching for faster performance
• TypeScript support

Installation

npm install @lunarisapp/readability

Usage

import { TextReadability } from '@lunarisapp/readability';

const textReadability = new TextReadability({
    lang: 'en_US', // optional, en_US by default
    cache: true,   // optional, true by default
});

textReadability.fleschReadingEase('Hello, world!');

The package also exports pure formulas, if you want to use them directly:

import { fleschReadingEase } from '@lunarisapp/readability';
fleschReadingEase({
    wordCount: 2,
    sentenceCount: 1,
    syllableCount: 6,
});

Algorithms

Other

import { type Language } from '@lunarisapp/readability';