reading-time

by ngryman

ngryman /reading-time

:books: Medium's like reading time estimation.

509 Stars 28 Forks Last release: Not found MIT License 44 Commits 10 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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

const readingTime = require('reading-time');

const stats = readingTime(text); // -> // stats: { // text: '1 min read', // minutes: 1, // time: 60000, // words: 200 // }

Stream

const readingTime = require('reading-time/stream');

fs.createReadStream('foo') .pipe(readingTime) .on('data', stats => { // ... });

API

readingTime(text, options?)
  • text
    : the text to analyze
  • options (optional)
    • options.wordsPerMinute
      : (optional) the words per minute an average reader can read (default: 200)
    • options.wordBound
      : (optional) a function that returns a boolean value depending on if a character is considered as a word bound (default: spaces, new lines and tabulations)

Author

| twitter/ngryman | | -------------------------------------------------------------------------------------------------------------------------------------------------- | | Nicolas Gryman |

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.