Naive Puppets Marching

    estimated-read-time
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/estimated-read-time package

    1.2.0 • Public • Published

    estimated-read-time

    NPM Github Downloads License

    estimated-read-time helps to estimate the time taken to read a content.

    Features

    1. Estimates the time taken to read any plain text content.
    2. Reduces the avg. reading WPM for a technical document based on its difficulty level.
    3. Calculate avg. WPM from previous total words and seconds. (Tip #1)

    Installation

    npm install estimated-read-time --save

    Usage

    var readtime = require('estimated-read-time');
     
    var result = readtime.text(content);
    //Returns
    //{
    //  word_count: 265
    //  seconds: 60
    //}

    API

    text(content, options)

    • content: the text to analyze
    • options.MIN_WORD_LEN: Avg Length of one word which will be used to count the no. of words in the content. (Default: 4)
    • options.WPM: Words Per Minute a person can read. (Default: 265)
    • options.IS_TECHNICAL_DOC: true or false indicating whether the content is a technical document. (Default: false)
    • options.TECH_DIFFICULTY: The Technical Difficulty of the content. Allowed values are 0 to 5. (Default: 3)
    • options.TOTAL_WORDS: Total Words read (Default: 0)
    • options.TOTAL_SECONDS: Total Seconds taken to read options.TOTAL_WORDS. (Default: 0)

    Note: The WPM calculated using options.TOTAL_WORDS and options.TOTAL_SECONDS takes higher precedence than options.WPM.

    ## Tips

    1. If you want to show the estimated reading time differently for each user based on their previous reading, then you can store the total words read by the user and the total seconds taken to read and pass them in options.TOTAL_WORDS and options.TOTAL_SECONDS.

    Install

    npm i estimated-read-time

    DownloadsWeekly Downloads

    11

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    5.86 kB

    Total Files

    5

    Last publish

    Collaborators

    • karthik512