sindresorhus / p-limit

Run multiple promise-returning & async functions with limited concurrency
MIT License
2.06k stars 106 forks source link

Misleading documentation: concurrency does not have a default value #87

Closed kevinyou closed 1 month ago

kevinyou commented 1 month ago

https://github.com/sindresorhus/p-limit/blob/98c8fef5562fabd900dfd9172013962889e13df6/readme.md?plain=1#L31-L43

The "default" is misleading. If an argument is not passed (undefined) it will throw a TypeError.

Either support concurrency as an optional parameter, or make this more clear in the documentation