npmpackage.info

reading-time-estimator

A medium's like reading time estimator with internationalization support

1.11.0

TypeScript

900.00 B

Installations

npm install reading-time-estimator

Pull Requests

Open

4

Total

1,678

Closed

57

Merged

1,617

Issues

Open

0

Total

36

Closed

36

Releases

v1.11.0

Published on 02 Apr 2024

v1.10.0

Published on 17 Mar 2024

v1.9.4

Published on 02 Jan 2024

v1.9.3

Published on 28 Dec 2023

v1.9.2

Published on 01 Dec 2023

v1.9.1

Published on 24 Nov 2023

View all 75 releases

Developer

lbenie

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

20.8.1

NPM Version

10.5.0 Statistics

40 Stars

1,732 Commits

13 Forks

4 Watching

4 Branches

10 Contributors

Updated on 28 Nov 2024

Bundle Size

1.56 kB

Minified

900.00 B

Minified + Gzipped

Bundlephobia

Languages

TypeScript (80.58%)

JavaScript (19.42%)

Total Downloads

Cumulative downloads

Total Downloads

315,299

Last day

4.1%

580

Compared to previous day

Last week

35.6%

3,763

Compared to previous week

Last month

6.1%

13,915

Compared to previous month

Last year

77.4%

148,320

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@lbenie/linting @rollup/plugin-typescript @semantic-release/changelog @semantic-release/git @semantic-release/github @semantic-release/release-notes-generator @types/node @vitest/coverage-v8 all-contributors-cli concurrently conventional-changelog-conventionalcommits rollup rollup-plugin-peer-deps-external rollup-plugin-typescript2 semantic-release typescript unplugin-auto-import vite vitest

Versions

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 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

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} 💻

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

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

SAST

Determines if the project uses static code analysis.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

Score

4.1

/10

Last Scanned on 2024-11-18

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