From 0c6101901daee3f053e28cd0c879287e8c81de1d Mon Sep 17 00:00:00 2001 From: Gryffon Bellish <39341355+PyroTechniac@users.noreply.github.com> Date: Sat, 1 Jun 2019 14:24:22 -0400 Subject: [PATCH] fix(docs): backport documentation for Presence#clientStatus (#3315) * backport documentation for Presence * capitalize o Co-Authored-By: SpaceEEC * remove extra space * backport ClientPresenceStatus * Change to Client Presence Status --- src/structures/Presence.js | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/structures/Presence.js b/src/structures/Presence.js index 47cf0a719..da6ec23a7 100644 --- a/src/structures/Presence.js +++ b/src/structures/Presence.js @@ -2,7 +2,6 @@ const { ActivityFlags, Endpoints } = require('../util/Constants'); /** * The status of this presence: - * * * **`online`** - user is online * * **`idle`** - user is AFK * * **`offline`** - user is offline or invisible @@ -10,6 +9,14 @@ const { ActivityFlags, Endpoints } = require('../util/Constants'); * @typedef {string} PresenceStatus */ +/** + * The status of this presence: + * * **`online`** - user is online + * * **`idle`** - user is AFK + * * **`dnd`** - user is in Do Not Disturb + * @typedef {string} ClientPresenceStatus + */ + /** * Represents a user's presence. */ @@ -31,10 +38,10 @@ class Presence { /** * The devices this presence is on - * @type {?object} - * @property {PresenceStatus} web - * @property {PresenceStatus} mobile - * @property {PresenceStatus} desktop + * @type {?Object} + * @property {?ClientPresenceStatus} web The current presence in the web application + * @property {?ClientPresenceStatus} mobile The current presence in the mobile application + * @property {?ClientPresenceStatus} desktop The current presence in the desktop application */ this.clientStatus = data.client_status || null; }