fix: document

This commit is contained in:
March 7th 2022-06-11 20:17:27 +07:00
parent c9f1010e54
commit 81bc22f388
4 changed files with 5 additions and 5 deletions

File diff suppressed because one or more lines are too long

View File

@ -10,8 +10,8 @@ module.exports = (client, { d: data }) => {
/** /**
* Emitted whenever a relationship is updated. * Emitted whenever a relationship is updated.
* @event Client#relationshipAdd * @event Client#relationshipAdd
* @param {UserId} user The userID that was updated * @param {Snowflake} user The userID that was updated
* @param {RelationshipTypes} type The new relationship type * @param {RelationshipTypes} type The new relationship type (String)
*/ */
client.emit(Events.RELATIONSHIP_ADD, data.id, RelationshipTypes[data.type]); client.emit(Events.RELATIONSHIP_ADD, data.id, RelationshipTypes[data.type]);
}; };

View File

@ -7,7 +7,7 @@ module.exports = (client, { d: data }) => {
/** /**
* Emitted whenever a relationship is updated. * Emitted whenever a relationship is updated.
* @event Client#relationshipRemove * @event Client#relationshipRemove
* @param {UserId} user The userID that was updated * @param {Snowflake} user The userID that was updated
*/ */
client.emit(Events.RELATIONSHIP_REMOVE, data.id); client.emit(Events.RELATIONSHIP_REMOVE, data.id);
}; };

View File

@ -18,7 +18,7 @@ class RelationshipsManager {
*/ */
this.client = client; this.client = client;
/** /**
* A collection of users this manager is caching. * A collection of users this manager is caching. (Type: Number)
* @type {Collection<Snowflake, RelationshipTypes>} * @type {Collection<Snowflake, RelationshipTypes>}
* @readonly * @readonly
*/ */