Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-17 03:53:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs/typings(SystemChannelFlags): properly document and use resolvable (#3794)

Browse Source 
- Change GuildEditData#systemChannelFlags to use SystemChannelFlagsResolvable
- Move SystemChannelFlagsResolvable outside of class definition to make the docs generator happy
This commit is contained in:
SpaceEEC
2020-02-24 13:03:45 +01:00
committed by GitHub
parent ccb83a71ee
commit d406f42ce0
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/util/SystemChannelFlags.js
View File

@@ -8,16 +8,16 @@ const BitField = require('./BitField');
* and by setting their corresponding flags you are disabling them</info> * and by setting their corresponding flags you are disabling them</info>
* @extends {BitField} * @extends {BitField}
*/ */
class SystemChannelFlags extends BitField { class SystemChannelFlags extends BitField {}
/**
* Data that can be resolved to give a sytem channel flag bitfield. This can be: /**
* * A string (see {@link SystemChannelFlags.FLAGS}) * Data that can be resolved to give a sytem channel flag bitfield. This can be:
* * A sytem channel flag * * A string (see {@link SystemChannelFlags.FLAGS})
* * An instance of SystemChannelFlags * * A sytem channel flag
* * An Array of SystemChannelFlagsResolvable * * An instance of SystemChannelFlags
* @typedef {string|number|SystemChannelFlags|SystemChannelFlagsResolvable[]} SystemChannelFlagsResolvable * * An Array of SystemChannelFlagsResolvable
*/ * @typedef {string|number|SystemChannelFlags|SystemChannelFlagsResolvable[]} SystemChannelFlagsResolvable
} */
/** /**
* Numeric system channel flags. All available properties: * Numeric system channel flags. All available properties:

2
typings/index.d.ts vendored
View File

@@ -2334,7 +2334,7 @@ declare module 'discord.js' {
defaultMessageNotifications?: DefaultMessageNotifications | number; defaultMessageNotifications?: DefaultMessageNotifications | number;
afkChannel?: ChannelResolvable; afkChannel?: ChannelResolvable;
systemChannel?: ChannelResolvable; systemChannel?: ChannelResolvable;
systemChannelFlags?: SystemChannelFlags; systemChannelFlags?: SystemChannelFlagsResolvable;
afkTimeout?: number; afkTimeout?: number;
icon?: Base64Resolvable; icon?: Base64Resolvable;
owner?: GuildMemberResolvable; owner?: GuildMemberResolvable;