todo: add JSDoc examples to simple functions

[iuioiua]

Most functions in /utils are simple functions that could do with a little documentation. Objectives:

1. Provide a short description of what the function does and/or its purpose.
2. Provide an @example snippet.
3. Keep It Simple, Stupid (KISS)
4. Link to relevant documentation, if needed.

Targets:

• /utils/db.ts
• /utils/http.ts
• /utils/islands.ts
• /utils/payments.ts
• /utils/posts.ts

[Nkiriobasi]

I’ll work on this

[iuioiua]

Great! I think it'd be best if we tackled this in chunks - like one PR per file.

[Nkiriobasi]

Alright, that’s fine

[Nkiriobasi]

Please I made two file changes in the first PR, it wasn’t intentional.

[roberto-morado]

I see 👀 there are some functions still, I would like to work on this as well.

@iuioiua could you assign me to this?

[iuioiua]

Hi @roberto-morado, I realised it'd be best if I were the one to work on this one, given I know the context and nuances behind a lot of this functionality. I assigned myself to make this clear. Thanks anyway for offering!

[roberto-morado]

No problem 👍

[iuioiua]

This has been completed in a number of the related PRs.