Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation for packages #46

Open
akaRem opened this issue Nov 21, 2019 · 2 comments
Open

Missing documentation for packages #46

akaRem opened this issue Nov 21, 2019 · 2 comments
Labels
documentation Improvements to docs are requested

Comments

@akaRem
Copy link

akaRem commented Nov 21, 2019

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

@brainkim
Copy link
Member

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 brainkim added the documentation Improvements to docs are requested label Nov 21, 2019
@akaRem
Copy link
Author

akaRem commented Nov 21, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to docs are requested
Projects
None yet
Development

No branches or pull requests

2 participants