Skip to content

Commit

Permalink
feat(Attachment): add flags (discordjs#9686)
Browse files Browse the repository at this point in the history
Co-authored-by: Almeida <[email protected]>
  • Loading branch information
2 people authored and vladfrangu committed Nov 4, 2023
1 parent f0b0a57 commit 8cb8fc0
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
37 changes: 37 additions & 0 deletions src/util/AttachmentFlags.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
'use strict';

const BitField = require('./BitField');

/**
* Data structure that makes it easy to interact with an {@link GuildMember#flags} bitfield.
* @extends {BitField}
*/
class AttachmentFlags extends BitField {}

/**
* @name AttachmentFlags
* @kind constructor
* @memberof AttachmentFlags
* @param {BitFieldResolvable} [bits=0] Bit(s) to read from
*/

/**
* Numeric guild member flags. All available properties:
* * `IS_REMIX`
* @type {Object}
* @see {@link https://discord.com/developers/docs/resources/channel#attachment-object-attachment-structure-attachment-flags}
*/
AttachmentFlags.FLAGS = {
IS_REMIX: 1 << 2,
};

/**
* Data that can be resolved to give a guild attachment bitfield. This can be:
* * A string (see {@link AttachmentFlags.FLAGS})
* * A attachment flag
* * An instance of AttachmentFlags
* * An Array of AttachmentFlagsResolvable
* @typedef {string|number|AttachmentFlags|AttachmentFlagsResolvable[]} AttachmentFlagsResolvable
*/

module.exports = AttachmentFlags;
9 changes: 9 additions & 0 deletions typings/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1715,6 +1715,7 @@ export class MessageAttachment {
public description: string | null;
public duration: number | null;
public ephemeral: boolean;
public flags: Readonly<AttachmentFlags>;
public height: number | null;
public id: Snowflake;
public name: string | null;
Expand All @@ -1731,6 +1732,14 @@ export class MessageAttachment {
public toJSON(): unknown;
}

export class AttachmentFlags extends BitField<AttachmentFlagsString> {
public static FLAGS: Record<AttachmentFlagsString, number>;
public static resolve(bit?: BitFieldResolvable<AttachmentFlagsString, number>): number;
}

export type AttachmentFlagsString =
| 'IS_REMIX';

export class MessageButton extends BaseMessageComponent {
public constructor(data?: MessageButton | MessageButtonOptions | APIButtonComponent);
public customId: string | null;
Expand Down

0 comments on commit 8cb8fc0

Please sign in to comment.