1.0.0 • Published 3 years ago

@iamtraction/read-time v1.0.0

Weekly downloads
4
License
MPL-2.0
Repository
github
Last release
3 years ago

Read Time

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

GitHub release Dependencies Known Vulnerabilities license Node.js CI Node.js Package

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);
ParameterTypeOptionalDefaultDescription
textStringNo-Text for which you want to estimate the read time.
optionsObjectYes-Options for read time estimation.
options.wpmNumberYes250Reading speed in words per minute.

Returns: string

@infinitebrahmanuniverse/nolb-_ia@everything-registry/sub-chunk-448@zalastax/nolb-_ia
1.0.0

3 years ago