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?

Why moment?

I needed to use the reading-time package, i love it but i need it with internacionalization. Probably the original package is lightweight intentionally developed, then i thought was better idea if i split into a new npm package for projects that you need a faster solution to reading time internacionalizated.

Installation

npm install reading-time-i18n --production

Usage

Classic

var readingTime = require('reading-time-i18n');


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

With different i18n locale

var readingTime = require('reading-time-i18n');

var stats = readingTime(text, {locale: 'es-ES'});
// ->
// stats: {
//   text: '1 min read',
//   time: 60000.
//   words: 200
//   i18nText: '1 minuto'
// }

Stream

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

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

API

readingTime(text, options?)

• text: the text to analyze
• 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)
• options.locale: (optional) i18n Locale for multilanguage text based on moment (default: en-GB)

Other projects

Nicolas Gryman

Contributors

• 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.

i18n Adapt

Jose Segura