Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngryman/reading-time
:books: Medium's like reading time estimation.
https://github.com/ngryman/reading-time
estimate medium reading-time
Last synced: 21 days ago
JSON representation
:books: Medium's like reading time estimation.
- Host: GitHub
- URL: https://github.com/ngryman/reading-time
- Owner: ngryman
- License: mit
- Created: 2014-03-21T03:33:01.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-05-30T08:35:16.000Z (over 1 year ago)
- Last Synced: 2024-10-01T11:05:16.994Z (about 1 month ago)
- Topics: estimate, medium, reading-time
- Language: TypeScript
- Homepage: https://ngryman.sh
- Size: 534 KB
- Stars: 1,369
- Watchers: 11
- Forks: 46
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - ngryman/reading-time - :books: Medium's like reading time estimation. (TypeScript)
README
# reading-time
[](https://www.npmjs.org/package/reading-time) [](https://travis-ci.org/ngryman/reading-time)
[Medium]'s like reading time estimation.
`reading-time` helps you estimate how long an article will take to read.
It works perfectly with plain text, but also with `markdown` or `html`.
Note that it's focused on performance and simplicity, so the number of words it will extract from other formats than plain text can vary a little. But this is an estimation right?
[medium]: https://medium.com
## Installation
```sh
npm install reading-time --production
```
## Usage
### Classic
```javascript
// In Node.js
const readingTime = require('reading-time');
// In the browser
const readingTime = require('reading-time/lib/reading-time');
const stats = readingTime(text);
// ->
// stats: {
// minutes: 1,
// time: 60000,
// words: {total: 200}
// }
console.log(`The reading time is: ${stats.minutes} min`);
```
🙋♂️ Why different imports for Node.js and the browser?
This library is primarily for Node.js. The entrypoint also exports a `ReadingTimeStream` class which is, without polyfills, not supported in browsers. A simple workaround is to import the underlying `lib/reading-time` module.
**Note that in the upcoming `2.0.0` version, this won't be necessary anymore.**
### Stream
```javascript
const {ReadingTimeStream, readingTimeWithCount} = require('reading-time');
const analyzer = new ReadingTimeStream();
fs.createReadStream('foo')
.pipe(analyzer)
.on('data', (count) => {
console.log(`The reading time is: ${readingTimeWithCount(count).minutes} min`);
});
```
🙋♂️ Can I use this in the browser?
Yes. You need to provide the appropriate polyfills. Please refer to your bundler's documentation.
## API
### `readingTime(text, options?)`
Returns an object with `minutes`, `time` (in milliseconds), and `words`.
```ts
type ReadingTimeResults = {
minutes: number;
time: number;
words: WordCountStats;
};
```
- `text`: the text to analyze
- options (optional)
- `options.wordsPerMinute`: (optional) the words per minute an average reader can read (default: 200)
- `options.wordBound`: (optional) a function that returns a boolean value depending on if a character is considered as a word bound (default: spaces, new lines and tabs)
### `countWords(text, options?)`
Returns an object representing the word count stats:
```ts
type WordCountStats = {
total: number;
};
```
- `text`: the text to analyze
- options (optional)
- `options.wordBound`: (optional) a function that returns a boolean value depending on if a character is considered as a word bound (default: spaces, new lines and tabs)
### `readingTimeWithCount(words, options?)`
Returns an object with `minutes` (rounded minute stats) and `time` (exact time in milliseconds).
- `words`: the word count stats
- options (optional)
- `options.wordsPerMinute`: (optional) the words per minute an average reader can read (default: 200)
Note that `readingTime(text, options) === readingTimeWithCount(countWords(text, options), options)`.
## Help wanted!
This library has been optimized for alphabetical languages and CJK languages, but may not behave correctly for other languages that don't use spaces for word bounds. If you find the behavior of this library to deviate significantly from your expectation, issues or contributions are welcomed!
## Other projects
- [Fauda](https://github.com/ngryman/fauda): configuration made simple.
- [Badge Size](https://github.com/ngryman/badge-size): Displays the size of a given file in your repository.
- [Commitizen Emoji](https://github.com/ngryman/cz-emoji): Commitizen adapter formatting commit messages using emojis.