Improve Doc comments

This is a Hacktoberfest task! You can read more about Hacktoberfest on our blog and see all tasks on our Hacktoberfest Project Board.

Summary

We need help with checking and improving the inline comments for this library using JSDoc.

Details

If you’ve never see JSDoc before, it’s the comment that go above functions. For example:

/**
   * Creates a new user.
   * 
   * Some longer description can go here.
   * 
   * @param {object} credentials The user login details.
   * @param {string} credentials.email The user's email address.
   * @param {string} credentials.password The user's password.
   */
  async signUp(credentials: { email: string; password: string }) {
    // ...
  }

[awalias]

it looks like this one might actually already be complete, I couldn’t find any methods missing JSDocs at the moment - will wait for @kiwicopple to confirm

[awalias]

thanks for the interest @fatmali , assigning you now 👍