Read time is based on the average reading speed of an adult (roughly 265 Words per minutes according to a Medium's article.
Install
$ npm install minutes-to-read
Usage
const m2r = ; ;// => less than a min to read ;// => less than a minute const longText = 'Lorem ipsum dolor sit am...' // 500 words ;// => 2 minutes to finish ;// => 250 minutes to read if your reading rate is 2 wpm
API
m2r(text)
- text (
string
): A paragraph, easy or sentence
Example:
;// => less than a minute ; // 500 words // => 2 minutes to finish
m2r(text, customText)
- text (
string
): A paragraph, easy or sentence - customText (
string
): A custom text you want to add
Example:
;// => less than a minute to finish
m2r(text, customText, wpm)
- text (
string
): A paragraph, easy or sentence - customText (
string
): A custom text you want to add - wpm (
number
): Custom words per minutes
Example:
For a 250 text at 2 words per minutes it will take 250 minutes.
; // 500 words // => 250 minutes to finish
m2r(text,wpm)
- text (
string
): A paragraph, easy or sentence - wpm (
number
): Custom words per minutes
Example:
For a 2 words text reading a word per minute it will take 2 minutes.
;// => 2 min to read
Team
Carlos Araham |
License
MIT License © Carlos Abraham