reading-time

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

Note: this library is primarily for Node apps. If you need to use it in browsers with a bundler like Webpack, the ReadingTimeStream module would not be available because only a subset of the exports is included. If you need to use the stream version in browser (e.g. with a browser polyfill of Buffer), use import ReadingTimeStream from 'reading-time/dist/stream' instead. (And please let us know if that happens—we can reconsider our prioritization.)

Usage

Classic

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

const stats = readingTime(text);
// ->
// stats: {
//   minutes: 1,
//   time: 60000,
//   words: {total: 200}
// }
console.log(`The reading time is: ${stats.minutes} min`);

Stream

const {ReadingTimeStream, readingTimeWithCount} = require('reading-time');

const analyzer = new ReadingTimeStream();
fs.createReadStream('foo')
  .pipe(analyzer)
  .on('data', (count) => {
    console.log(`The reading time is: ${readingTimeWithCount(count).minutes} min`);
  });

API

readingTime(text, options?)

Returns an object with minutes, time (in milliseconds), and words.

type ReadingTimeResults = {
  minutes: number;
  time: number;
  words: WordCountStats;
};

• 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 tabs)

countWords(text, options?)

Returns an object representing the word count stats:

type WordCountStats = {
  total: number;
};

• text: the text to analyze
• options (optional)
  • 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 tabs)

readingTimeWithCount(words, options?)

Returns an object with minutes (rounded minute stats) and time (exact time in milliseconds).

• words: the word count stats
• options (optional)
  • options.wordsPerMinute: (optional) the words per minute an average reader can read (default: 200)

Note that readingTime(text, options) === readingTimeWithCount(countWords(text, options), options).

Help wanted!

This library has been optimized for alphabetical languages and CJK languages, but may not behave correctly for other languages that don't use spaces for work bounds. If you find the behavior of this library to deviate significantly from your expectation, issues or contributions are welcomed!

Other projects

• Fauda: configuration made simple.
• Badge Size: Displays the size of a given file in your repository.
• Commitizen Emoji: Commitizen adapter formatting commit messages using emojis.