Gathering detailed insights and metrics for reading-time-estimator
Gathering detailed insights and metrics for reading-time-estimator
A medium's like reading time estimator with internationalization support
Installations
npm install reading-time-estimatorDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
20.19.0
NPM Version
10.5.0
Releases
78
Languages
2
TypeScript
JavaScript
TypeScript (84.13%)
JavaScript (15.87%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
54 Stars
1,986 Commits
16 Forks
3 Watchers
1 Branches
12 Contributors
Updated on Jul 12, 2025
Maintainers
1
Package Meta Information
Latest Version
1.14.0
Package Id
reading-time-estimator@1.14.0
Unpacked Size
447.50 kB
Size
144.34 kB
File Count
27
NPM Version
10.5.0
Node Version
20.19.0
Published on
Apr 16, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
20
@lbenie/linting@rollup/plugin-typescript@semantic-release/changelog@semantic-release/git@semantic-release/github@semantic-release/release-notes-generator@types/node@types/sanitize-html@vitest/coverage-v8all-contributors-cliconcurrentlyconventional-changelog-conventionalcommitsrolluprollup-plugin-peer-deps-externalrollup-plugin-typescript2semantic-releasetypescriptunplugin-auto-importvitevitest
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
1 npm install reading-time-estimator
or Yarn
1 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 it supports these locales: en, fr, es, pt-br, zh-cn, zh-tw, ja, de, tr, ro, bn, sk and cs.
Usage
Try it live here
1import { readingTime } from 'reading-time-estimator' 2 3const text = 'some text to parse' 4 5// default options 6const result = readingTime(text, 10) 7 8// output: 9// { 10// minutes: 4, 11// words: 43, 12// text: `4 min read` 13// } 14 15// with french locale 16const result = readingTime(text, 10, 'fr') 17 18// output: 19// { 20// minutes: 4, 21// words: 43, 22// text: `4 min de lecture` 23// }
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 💻 |  Luo Wenjie 💻 |  CK Wong 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (30) are checked with a SAST tool
Reason
Found 0/1 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/commintlint.yml:1
- Warn: no topLevel permission defined: .github/workflows/format.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commintlint.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/commintlint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commintlint.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/commintlint.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/commintlint.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/commintlint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/format.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/format.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/format.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/format.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/format.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/format.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/format.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/format.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/lbenie/reading-time-estimator/test.yml/main?enable=pin
- Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v1.14.0 not signed: https://api.github.com/repos/lbenie/reading-time-estimator/releases/212846129
- Warn: release artifact v1.13.0 not signed: https://api.github.com/repos/lbenie/reading-time-estimator/releases/212526362
- Warn: release artifact v1.12.0 not signed: https://api.github.com/repos/lbenie/reading-time-estimator/releases/207713669
- Warn: release artifact v1.11.0 not signed: https://api.github.com/repos/lbenie/reading-time-estimator/releases/149435454
- Warn: release artifact v1.10.0 not signed: https://api.github.com/repos/lbenie/reading-time-estimator/releases/146925990
- Warn: release artifact v1.14.0 does not have provenance: https://api.github.com/repos/lbenie/reading-time-estimator/releases/212846129
- Warn: release artifact v1.13.0 does not have provenance: https://api.github.com/repos/lbenie/reading-time-estimator/releases/212526362
- Warn: release artifact v1.12.0 does not have provenance: https://api.github.com/repos/lbenie/reading-time-estimator/releases/207713669
- Warn: release artifact v1.11.0 does not have provenance: https://api.github.com/repos/lbenie/reading-time-estimator/releases/149435454
- Warn: release artifact v1.10.0 does not have provenance: https://api.github.com/repos/lbenie/reading-time-estimator/releases/146925990
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
19 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-x4c5-c7rf-jjgv
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-9crc-q9x8-hgqq
Score
3.4
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More