Docs for permissionoverwrites

This commit is contained in:
Amish Shah
2016-08-18 13:33:02 +01:00
parent 3ac191a812
commit 839ff5ce43
2 changed files with 16 additions and 1 deletions

View File

@@ -1,5 +1,12 @@
/**
* Represents a permission overwrite for a Role or Member in a Guild Channel.
*/
class PermissionOverwrites {
constructor(guildChannel, data) {
/**
* The GuildChannel this overwrite is for
* @type {GuildChannel}
*/
this.channel = guildChannel;
if (data) {
this.setup(data);
@@ -7,7 +14,15 @@ class PermissionOverwrites {
}
setup(data) {
/**
* The type of this overwrite
* @type {String}
*/
this.type = data.type;
/**
* The ID of this overwrite, either a User ID or a Role ID
* @type {String}
*/
this.id = data.id;
this.denyData = data.deny;
this.allowData = data.allow;