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

- 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

View File

@@ -8,8 +8,9 @@ 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: * Data that can be resolved to give a sytem channel flag bitfield. This can be:
* * A string (see {@link SystemChannelFlags.FLAGS}) * * A string (see {@link SystemChannelFlags.FLAGS})
* * A sytem channel flag * * A sytem channel flag
@@ -17,7 +18,6 @@ class SystemChannelFlags extends BitField {
* * An Array of SystemChannelFlagsResolvable * * An Array of SystemChannelFlagsResolvable
* @typedef {string|number|SystemChannelFlags|SystemChannelFlagsResolvable[]} 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;