Can you please add a license to this project?

Just jumping in to say that, with my current setup, v1.4.0 worked fine without any changes, but updating to v1.5.0 required me to add the following to my webpack config:

node: {
  global: true
},
resolve: {
  fallback: {
    stream: 'stream-browserify'
  }
},
plugins: [
  new webpack.ProvidePlugin({
    process: 'process/browser',
    Buffer: ['buffer', 'Buffer']
  })
]

and had to install stream-browserify.

The problematic line was const Transform = require('stream').Transform, but this line is also present in v1.4.0. This is a node core package, so it is expected for some kind of polyfill to be needed, but for some strange reason, v1.4.0 just works without any particular configuration change. 🤷‍♂️

Originally posted by @miguelcobain in #38 (comment)

Currently the minutes returns 5.87 or 6.43 like this.

But nobody wanted to read like that. I checked the source and it seems the round is added, but it's not working.

Could be a bug?

Here's a minimal reproduction: https://stackblitz.com/edit/node-nyf9tn?file=index.js

Run node index to see the result.

My nextjs cannot find type declarations

When I am using following line

     const readingTime = require('reading-time/stream');

I am getting an error module reading-time/stream not found. Could you please show an example how can we use that

Thank You
Sourabh Somani

Word counting is not as trivial as it seems. Most languages use spaces to separate words, but languages like Chinese and Japanese treat each character as a word, and there are no spaces. Therefore, we treat them slightly differently from Latin languages.

If you:

1. Know a non-CJK language that doesn't use spaces to separate words
2. Know the exact unicode range of characters that can be "standalone words"
3. Have backed up arguments about whether Katakana characters should be counted as words (see #35 (comment))
4. Other valuable comments about our implementation

Please don't hesitate to open an issue, send a pull request, or reach out to me or @ngryman in any possible way!

Here are a few changes we can make in v2 (most of which @ngryman has also mentioned), roughly in order of decreasing importance:

0. Refactor the API to expose two separate functions;
1. Remove text from the function return;
2. Remove the badly named IOptions export;
3. Migrate to TypeScript completely;
4. Prefer ESM to CJS (once we have TypeScript this is just a matter of setting the transpilation target);
5. Use a class-based implementation of readingTimeStream;
6. Change the testing library from mocha to Jest.

@ngryman If you have limited availability, I can be here to help.

There is a weird behaviour that causes reading-time to return null.

const t = require('reading-time');

t('OK'); // -> { time: ... }

// but
t('O'); // -> null

// whereas
t('😊'); // -> { time: ... } (certainly because it is a two bytes char)
t(''); // -> { time: ... }

So I am not sure why null is returned and if it should rather throw an exception or anything. But 'one letter' is definitely 'one word' and should consistently return an object.

An error (and not null) should rather be raised if the given input is not a string (not being able to be stringified — not sure we want to be able to try to get a result for { foo: 'bar' } argument).

Just noticed the above function is documented but not available in NPM:

• https://www.npmjs.com/package/reading-time?activeTab=code

The same appears to be true for countWords().

Version 3.4.0 of mocha just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As mocha is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

We used to import 'reading-time' module as es6 module, now we get this error
Module '"reading-time"' resolves to a non-module entity and cannot be imported using this construct.

Also, the API provided minutes stat which is gone.

I'm considering making a VS Code extension using this library ... is this being actively updated?

Will the API be modified as per this issue? #18

Also, I noticed that the typescript typings file does not include the options argument.

Or do you recommend I fork this?

Currently readingTime returns an object of the form:

{
  text: displayed + ' min read',
  minutes: minutes,
  time: time,
  words: words
}

That's too much and it's not easily composable. Let's decouple things and expose this API:

export const countWords = (text: string, options?: { bound?: string => boolean }): number
export const readingTime = (wordCount: number, options?: { wordsPerMinute?: number }): number
export default function(text, options) {
  return readingTime(countWords(text, options), options)
}

I'm working on a browser-based, vanilla, non-node project, and thus, I can't just do an npm install and go. Instead, I'm stuck including .js files via <script src=""> tags. It would be nice if you could provide .js files of the code -- perhaps minimized and un-minimized versions.

it would be nice to provide a code playground of this library, in order to test it with no effort & check if it suits the needs of those who want to use Reading-time lib

Hi, I’m Japanese developer. Japanese is my native language.

If you have some time, please read this issue and respond any comments, suggestions, indicates

Premise

I already checked PR below.

#35

Background

I want to use this library for Japanese, but cannot use when I see https://github.com/ngryman/reading-time#help-wanted

I want to solve this problem !!

Main subject

In fact, calculation of Japanese reading-time is below.

reading-time [min] = charaters length / 600

ex: こんにちは、お元気ですか？
reading-time [min] = 13 / 600
「、」「。」「？」「！」is not pronounced, but pass time. So count 13 chars

So, if I can specify Japanese with some option, this library can calculate Japanese reading-time.

But, this library is used by mainly who uses English.

So, calculation is by word count.

If supply options to function like below, this library can count CJK languages,

type LangType = "en" | ... | "ja" | "cn" | "ko"
// cn = china, ko = korea
const stats = readingTime(text,lang="ja");

I’m not native of Chinese, Korean, so I don’t know about that truly.

By using Google, I can get a plausible value.

Additional

By using library below, we can count words.

https://github.com/leungwensen/tiny-segmenter

Would be nice.

Does the current version only support text but not markdown and html?

Hi,

Its possible translate or change text "min read"?

Thanks

Hi there,

do you mind if I propose a PR which accepts a readableStream (and possibly works with Buffers rather than string conversion)?

Thanks :-)