https://github.com/jungwoo-an/time-to-read
A lightweight (1kB) Estimate time to read (support cjk)
https://github.com/jungwoo-an/time-to-read
cjk estimate lightweight medium mit-license reading-time time-to-read
Last synced: 9 months ago
JSON representation
A lightweight (1kB) Estimate time to read (support cjk)
- Host: GitHub
- URL: https://github.com/jungwoo-an/time-to-read
- Owner: Jungwoo-An
- Created: 2019-02-18T11:41:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T16:00:50.000Z (over 7 years ago)
- Last Synced: 2025-09-23T02:27:56.640Z (10 months ago)
- Topics: cjk, estimate, lightweight, medium, mit-license, reading-time, time-to-read
- Language: JavaScript
- Homepage:
- Size: 48.8 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Time To Read
입력 받은 콘텐츠에서 읽기 시간을 측정합니다.
### 설치
```bash
npm install --save time-to-read
```
### 사용 방법
```js
const timeToRead = require('time-to-read');
timeToRead('text');
timeToRead('text', options);
```
#### Option (optional)
| 이름 | 타입 | 기본 값 (default) | 설명 |
| ------ | ------ | ----------------- | ----------------------- |
| wpm | number | 265 | 분당 단어 수 (English) |
| cjkCpm | number | 500 | 분당 character 수 (CJK) |
#### Output
| 이름 | 타입 | 설명 |
| -------------- | ------ | ---------------- |
| readingTime | number | 측정된 읽기 시간 |
| enReadingTime | number | 영문 읽기 시간 |
| cjkReadingTime | number | CJK 읽기 시간 |
| wordCount | number | 영어 단어 수 |
| cjkCount | number | CJK character 수 |
### 참고 자료
- [Medium](https://help.medium.com/hc/en-us/articles/214991667-Read-time)
- [Wikipedia]()