invertase / denque

The fastest javascript implementation of a double-ended queue. Used by the official Redis, MongoDB, MariaDB & MySQL libraries for Node.js and many other libraries.
https://docs.page/invertase/denque
Apache License 2.0
353 stars 33 forks source link

Documentation for part of public API is missed #38

Open FlyingDR opened 3 years ago

FlyingDR commented 3 years ago

At the time of submitting this report documentation seems to miss part of public API. Following methods and property are not mentioned:

Lack of size() is especially confusing because it gives a feeling that there is no way to get queue length. length property is mentioned, but not as part of API, but inside examples, which makes it less visible.