grolicek / reading-time-estimator

A medium's like reading time estimator with internationalization support

reading-time-estimator

A medium's like reading time estimator with internationalization support.

Documentation

Reading Time Estimator was created to provide an estimate of how long to read an article or blog as seen on medium.

Installation

With NPM

  npm install reading-time-estimator

or Yarn

  yarn add reading-time-estimator

API

The api is fairly simple. Here are the types definition for this module.

It is a simple function that takes the data as a required argument with the words per minute and locale as optional arguments.

Per default the locale is set to english en.

Per default the word per minute is set to 300.

At the moment there is only 12 supported locales: en, fr, es, pt-br, cn, ja, de, tr, ro, bn, sk and cs.

Usage

Try it live here

import { readingTime } from 'reading-time-estimator'

const text = 'some text to parse'

// default options
const result = readingTime(text, 10)

// output:
// {
//   minutes: 4,
//   words: 43,
//   text: `4 min read`
// }

// with french locale
const result = readingTime(text, 10, 'fr')

// output:
// {
//   minutes: 4,
//   words: 43,
//   text: `4 min de lecture`
// }

Why Not ...?

reading-time

This package does not offer internationalization support which was a must for me.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Lucien Bénié 💻 📖	Victor Sierra 💻	ZhangC 💻	Rich11 💻 📖	Matheus Oliveira 💻	Can Güven 💻	Alexander Strutz 💻
凝结尾迹 💻	Muhammad Faisal Amin 💻	Oliver Groma 💻

This project follows the all-contributors specification. Contributions of any kind welcome!