read-time

A Node.JS library to estimate the time it will take to read a given text.

MPL-2.0 License

Downloads
11
Stars
6

Read Time

A Node.JS library to estimate the time it will take to read a given text.

Installation

# Stable version, from npm repository
npm install --save @iamtraction/read-time

# Latest version, from GitHub repository
npm install --save iamtraction/read-time

Usage

// If you've installed from npm
const readTime = require("@iamtraction/read-time");

// If you've installed from GitHub
const readTime = require("read-time");

Method: calculate(text, options)

readTime.calculate(text, options);
Parameter Type Optional Default Description
text String No - Text for which you want to estimate the read time.
options Object Yes - Options for read time estimation.
options.wpm Number Yes 250 Reading speed in words per minute.

Returns: string

Package Rankings
Top 31.82% on Npmjs.org
Badges
Extracted from project README
GitHub release Dependencies Known Vulnerabilities license