mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
docs(BitField): document constructors of deriving classes (#3903)
This commit is contained in:
@@ -8,6 +8,13 @@ const BitField = require('./BitField');
|
|||||||
*/
|
*/
|
||||||
class ActivityFlags extends BitField {}
|
class ActivityFlags extends BitField {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name ActivityFlags
|
||||||
|
* @kind constructor
|
||||||
|
* @memberof ActivityFlags
|
||||||
|
* @param {BitFieldResolvable} [bits=0] Bit(s) to read from
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Numeric activity flags. All available properties:
|
* Numeric activity flags. All available properties:
|
||||||
* * `INSTANCE`
|
* * `INSTANCE`
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ const { RangeError } = require('../errors');
|
|||||||
*/
|
*/
|
||||||
class BitField {
|
class BitField {
|
||||||
/**
|
/**
|
||||||
* @param {BitFieldResolvable} [bits=0] Bits(s) to read from
|
* @param {BitFieldResolvable} [bits=0] Bit(s) to read from
|
||||||
*/
|
*/
|
||||||
constructor(bits) {
|
constructor(bits) {
|
||||||
/**
|
/**
|
||||||
@@ -48,7 +48,7 @@ class BitField {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets all given bits that are missing from the bitfield.
|
* Gets all given bits that are missing from the bitfield.
|
||||||
* @param {BitFieldResolvable} bits Bits(s) to check for
|
* @param {BitFieldResolvable} bits Bit(s) to check for
|
||||||
* @param {...*} hasParams Additional parameters for the has method, if any
|
* @param {...*} hasParams Additional parameters for the has method, if any
|
||||||
* @returns {string[]}
|
* @returns {string[]}
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -7,6 +7,13 @@ const BitField = require('./BitField');
|
|||||||
*/
|
*/
|
||||||
class Intents extends BitField {}
|
class Intents extends BitField {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name Intents
|
||||||
|
* @kind constructor
|
||||||
|
* @memberof Intents
|
||||||
|
* @param {IntentsResolvable} [bits=0] Bit(s) to read from
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Data that can be resolved to give a permission number. This can be:
|
* Data that can be resolved to give a permission number. This can be:
|
||||||
* * A string (see {@link Intents.FLAGS})
|
* * A string (see {@link Intents.FLAGS})
|
||||||
|
|||||||
@@ -8,6 +8,13 @@ const BitField = require('./BitField');
|
|||||||
*/
|
*/
|
||||||
class MessageFlags extends BitField {}
|
class MessageFlags extends BitField {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name MessageFlags
|
||||||
|
* @kind constructor
|
||||||
|
* @memberof MessageFlags
|
||||||
|
* @param {BitFieldResolvable} [bits=0] Bit(s) to read from
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Numeric message flags. All available properties:
|
* Numeric message flags. All available properties:
|
||||||
* * `CROSSPOSTED`
|
* * `CROSSPOSTED`
|
||||||
|
|||||||
@@ -9,6 +9,13 @@ const BitField = require('./BitField');
|
|||||||
* @extends {BitField}
|
* @extends {BitField}
|
||||||
*/
|
*/
|
||||||
class Permissions extends BitField {
|
class Permissions extends BitField {
|
||||||
|
/**
|
||||||
|
* @name Permissions
|
||||||
|
* @kind constructor
|
||||||
|
* @memberof Permissions
|
||||||
|
* @param {PermissionResolvable} [bits=0] Bit(s) to read from
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Data that can be resolved to give a permission number. This can be:
|
* Data that can be resolved to give a permission number. This can be:
|
||||||
* * A string (see {@link Permissions.FLAGS})
|
* * A string (see {@link Permissions.FLAGS})
|
||||||
|
|||||||
@@ -9,6 +9,13 @@ const BitField = require('./BitField');
|
|||||||
*/
|
*/
|
||||||
class Speaking extends BitField {}
|
class Speaking extends BitField {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name Speaking
|
||||||
|
* @kind constructor
|
||||||
|
* @memberof Speaking
|
||||||
|
* @param {BitFieldResolvable} [bits=0] Bit(s) to read from
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Numeric speaking flags. All available properties:
|
* Numeric speaking flags. All available properties:
|
||||||
* * `SPEAKING`
|
* * `SPEAKING`
|
||||||
|
|||||||
@@ -10,6 +10,13 @@ const BitField = require('./BitField');
|
|||||||
*/
|
*/
|
||||||
class SystemChannelFlags extends BitField {}
|
class SystemChannelFlags extends BitField {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name SystemChannelFlags
|
||||||
|
* @kind constructor
|
||||||
|
* @memberof SystemChannelFlags
|
||||||
|
* @param {SystemChannelFlagsResolvable} [bits=0] Bit(s) to read from
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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})
|
||||||
|
|||||||
Reference in New Issue
Block a user