Have ideas to improve npm?Join in the discussion! »

    flesch-kincaid
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    flesch-kincaid

    Build Coverage Downloads Size

    Formula to detect the grade level of text according to the Flesch–Kincaid grade level.

    See syllable for detecting syllables.

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install flesch-kincaid

    Use

    import {fleschKincaid} from 'flesch-kincaid'
    
    // For “The Australian platypus is seemingly a hybrid of a mammal and reptilian
    // creature.” (1 sentence, 13 words, 26 syllables).
    fleschKincaid({sentence: 1, word: 13, syllable: 26})
    // => 13.08

    API

    This package exports the following identifiers: fleschKincaid. There is no default export.

    fleschKincaid(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 U.S. grade level associated with the document.

    Values can theoretically start at -3.40 and end at Infinity.

    Related

    • automated-readability — Uses character count instead of error-prone syllable parser
    • coleman-liau — Uses letter count instead of an error-prone syllable parser
    • dale-chall-formula — Uses a dictionary; suited for higher reading levels
    • flesch — Uses syllable count
    • gunning-fog — Uses syllable count, needs POS-tagging and NER
    • smog-formula — Like gunning-fog-index, without needing advanced NLP
    • spache-formula — Uses a dictionary, suited for lower reading levels

    License

    MIT © Titus Wormer

    Install

    npm i flesch-kincaid

    DownloadsWeekly Downloads

    128

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    7.39 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar