Commit e4e40347 authored by Hugo "ThePooN" Denizart's avatar Hugo "ThePooN" Denizart
Browse files

Docs: Fix various missing async tags

parent e8adfd55
Pipeline #3136 passed with stage
in 49 seconds
...@@ -67,6 +67,7 @@ class BanchoChannel extends EventEmitter { ...@@ -67,6 +67,7 @@ class BanchoChannel extends EventEmitter {
/** /**
* Sends a message to this channel * Sends a message to this channel
* *
* @async
* @throws {Error} If we're offline * @throws {Error} If we're offline
* @param {string} message * @param {string} message
* @returns {Promise<null>} Resolves when message is sent (rate-limiting) * @returns {Promise<null>} Resolves when message is sent (rate-limiting)
......
...@@ -69,6 +69,7 @@ class BanchoUser extends EventEmitter { ...@@ -69,6 +69,7 @@ class BanchoUser extends EventEmitter {
/** /**
* Fetch the user from the osu! API if possible. Populates all the "optional" properties of BanchoUser. * Fetch the user from the osu! API if possible. Populates all the "optional" properties of BanchoUser.
* *
* @async
* @throws {Error} osu! API/no API key error * @throws {Error} osu! API/no API key error
* @returns Promise<nodesu.User> * @returns Promise<nodesu.User>
*/ */
...@@ -118,6 +119,7 @@ class BanchoUser extends EventEmitter { ...@@ -118,6 +119,7 @@ class BanchoUser extends EventEmitter {
/** /**
* Sends a PM to this user. * Sends a PM to this user.
* *
* @async
* @throws {Error} If we're offline * @throws {Error} If we're offline
* @param {string} message * @param {string} message
* @returns {Promise<null>} Resolves when message is sent (rate-limiting) * @returns {Promise<null>} Resolves when message is sent (rate-limiting)
......
...@@ -404,6 +404,7 @@ class BanchoLobby extends EventEmitter { ...@@ -404,6 +404,7 @@ class BanchoLobby extends EventEmitter {
/** /**
* Fetch the lobby from the osu! API. * Fetch the lobby from the osu! API.
* *
* @async
* @returns Promise<nodesu.Multi> * @returns Promise<nodesu.Multi>
*/ */
fetchFromAPI() { fetchFromAPI() {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment