Nuclear Powered Marshmallows
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    reading-timepublic

    reading-time

    NPM Build Status


    Medium's like reading time estimation.

    reading-time helps you estimate how long an article will take to read. It works perfectly with plain text, but also with markdown or html.

    Note that it's focused on performance and simplicity, so the number of words it will extract from other formats than plain text can vary a little. But this is an estimation right?

    Installation

    npm install reading-time --production

    Usage

    Classic

    var readingTime = require('reading-time');
     
    var stats = readingTime(text);
    // -> 
    // stats: { 
    //   text: '1 min read', 
    //   time: 60000. 
    //   words: 200 
    // } 

    Stream

    var readingTime = require('reading-time/stream');
     
    fs.createReadStream('foo').pipe(readingTime).on('data', function(stats) {
        // ... 
    });

    Author

    twitter/ngryman
    Nicolas Gryman

    install

    npm i reading-time

    Downloadslast 7 days

    1,712

    version

    1.1.0

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar