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 = ; var stats = ;// ->// stats: {// text: '1 min read',// time: 60000.// words: 200// i18nText: '1 minute'// }
With different i18n locale
var readingTime = ; var stats = ;// ->// stats: {// text: '1 min read',// time: 60000.// words: 200// i18nText: '1 minuto'// }
Stream
var readingTime = ; fs;
API
readingTime(text, options)
text
: the text to analyzeoptions.wordsPerMinute
: the words per minute an average reader can read (default: 200)options.wordBound
: a function than return if a character is considered as a word bound (default: spaces, new lines and tabulations)options.locale
: i18n Locale for multilanguage text based on moment (default: en-GB)
Author
Nicolas Gryman |
Contributors
Jose Segura |