New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

read-time-estimate

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

read-time-estimate

A Medium like read time estimate with more accuracy and customisable values

  • 0.0.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.1K
increased by15.09%
Maintainers
1
Weekly downloads
 
Created
Source

read-time-estimate Build Status CodeFactor Maintainability Test Coverage npm version npm downloads

A more accurate Medium like read time estimate with images in progression and Chinese / Japanese / Korean character support.

Features

  • Calculates read time of images in decreasing progression with ability to provide custom image tags (Example - 12 seconds for the first image, 11 for the second, until images counted at 3 seconds)
  • Calculates read time of the Chinese / Japanese / Korean characters separately
  • Removes unwanted html tags to calculate read time more efficiently

Install

$ npm i read-time-estimate --save

Usage

const readTimeEstimate = require('read-time-estimate');

const string = `<img src="test.png"/><div class="wrapper">
    This is a sample read time estimate with 中文/日文/韩文 text </div>`
                
const {
    humanizedDuration, // 'less than a minute'
    duration, // 0.23272727272727273
    totalWords, // 9
    wordTime, // 0.03272727272727273
    totalImages, // 1
    imageTime, //  0.2
    otherLanguageTimeCharacters, // 6
    otherLanguageTime, // 0.012
} = readTimeEstimate(string, 275, 12, 500, ['img', 'Image'])

Input

VariableDefaultsTypeDescription
stringrequiredstringInput String
customWordTime275numberSpeed of reading the text in Words per Minute
customImageTime12numberSpeed of reading the image in seconds
chineseKoreanReadTime500numberSpeed of reading the Chinese / Korean / Japanese characters in Characters per Minute
imageTags['img', 'Image']arrayCustom Image tags to parse in the input string

Output

VariableTypeDescription
humanizedDurationstringHumanized Duration for the input string
durationnumberActual Duration of the input string (in minutes)
totalWordsnumberNumber of words in the input string
wordTimenumberRead Time of the words in the input string (in minutes)
totalImagesnumberNumber of images in input string
imageTimenumberRead Time of the images in the input string (in minutes)
otherLanguageTimeCharactersnumberChinese / Japanese / Korean language characters count
otherLanguageTimenumberRead Time of the Chinese / Japanese / Korean in the input string (in minutes)

References

Medium

Contribution

Questions

Feel free to contact me or create an issue

Keywords

FAQs

Package last updated on 06 Jan 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc