repeater icon indicating copy to clipboard operation
repeater copied to clipboard

Missing documentation for packages

Open akaRem opened this issue 5 years ago • 2 comments

readmes at https://www.npmjs.com/package/@repeaterjs/timers https://www.npmjs.com/package/@repeaterjs/pubsub https://www.npmjs.com/package/@repeaterjs/limiters say go to https://repeater.js.org/ where there is no info about these packages

akaRem avatar Nov 21 '19 16:11 akaRem

Yeah I haven’t really written any documentation for those packages which are mostly experimental (0.x). There is this page: https://repeater.js.org/docs/utilities. The reason is that I’m not entirely sure what the APIs for these packages should be. The only package which I am reasonably confident in is timers, but even then I’m considering renaming the functions from interval to createInterval and timeout to createTimeout because the function names keep squatting on the most expected name of the return value. If you want to learn more about these packages, the best way is to read through the source, as these packages are <200 lines of code. Should give you a better handle on how to use repeaters for advanced use-cases as well.

brainkim avatar Nov 21 '19 16:11 brainkim

Yes, I mostly looking through tests. But it's not very convenient..

akaRem avatar Nov 21 '19 18:11 akaRem