chore: add basic JSDocs

[aryaemami59]

This PR:

• [X] Adds basic JSDocs.

[pkg-pr-new[bot]]

Open in StackBlitz

npm i https://pkg.pr.new/tinyglobby@101

commit: 414d967

[aryaemami59]

@SuperchupuDev Could you please take a look at this one at some point?

[SuperchupuDev]

hi! thanks for the pr. reason why i haven't looked into it yet is because i'm yet to decide in terms of doing jsdocs, as doing them will increase the download size and it could be a big increase over time. the possible options are 1) no jsdocs 2) jsdocs with reduced explanations and only in things that aren't self explanatiory 3) jsdocs everywhere like this pr adds. current focus on tinyglobby are bug fixes, and improvements like this one will probably be the focus afterwards. so no eta but just letting you know i haven't forgotten about this 👍

[aryaemami59]

hi! thanks for the pr. reason why i haven't looked into it yet is because i'm yet to decide in terms of doing jsdocs, as doing them will increase the download size and it could be a big increase over time. the possible options are 1) no jsdocs 2) jsdocs with reduced explanations and only in things that aren't self explanatiory 3) jsdocs everywhere like this pr adds. current focus on tinyglobby are bug fixes, and improvements like this one will probably be the focus afterwards. so no eta but just letting you know i haven't forgotten about this 👍

If you have tooling and a build step, it will not add to the bundle size at all. And even if it did, the current JSDocs I've added are not that verbose and I think the benefit of having inline documentation that you could look at it by hovering your mouse over things far outweighs any potential negatives it could have if any.

I appreciate you looking at this, no rush, just wanted to make sure you knew about it. In the meantime if I can help with anything else feel free to let me know, I'd be happy to help.

[SuperchupuDev]

hello, once again thank you for opening the pr. lately i've been working on a documentation page for the library, which i've just published. for the jsdoc, i've copied over the information from the docs page in d5da27f, which supersedes this pr. but thanks a lot for the efforts and interest anyways :heart: