-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(attachment): don't return attachment builders from API (#7852)
Co-authored-by: Almeida <almeidx@pm.me> Co-authored-by: A. Román <kyradiscord@gmail.com> Co-authored-by: SpaceEEC <spaceeec@yahoo.com>
- Loading branch information
4 people
authored
Jun 4, 2022
1 parent
546d486
commit dfadcbc
Showing
11 changed files
with
166 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
packages/discord.js/src/structures/AttachmentBuilder.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| 'use strict'; | ||
|
|
||
| const Util = require('../util/Util'); | ||
|
|
||
| /** | ||
| * Represents an attachment builder | ||
| */ | ||
| class AttachmentBuilder { | ||
| /** | ||
| * @param {BufferResolvable|Stream} attachment The file | ||
| * @param {APIAttachment} [data] Extra data | ||
| */ | ||
| constructor(attachment, data = {}) { | ||
| /** | ||
| * The file associated with this attachment. | ||
| * @type {BufferResolvable|Stream} | ||
| */ | ||
| this.attachment = attachment; | ||
| /** | ||
| * The name of this attachment | ||
| * @type {?string} | ||
| */ | ||
| this.name = data.name; | ||
| /** | ||
| * The description of the attachment | ||
| * @type {?string} | ||
| */ | ||
| this.description = data.description; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the description of this attachment. | ||
| * @param {string} description The description of the file | ||
| * @returns {AttachmentBuilder} This attachment | ||
| */ | ||
| setDescription(description) { | ||
| this.description = description; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the file of this attachment. | ||
| * @param {BufferResolvable|Stream} attachment The file | ||
| * @returns {AttachmentBuilder} This attachment | ||
| */ | ||
| setFile(attachment) { | ||
| this.attachment = attachment; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the name of this attachment. | ||
| * @param {string} name The name of the file | ||
| * @returns {AttachmentBuilder} This attachment | ||
| */ | ||
| setName(name) { | ||
| this.name = name; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether this attachment is a spoiler | ||
| * @param {boolean} [spoiler=true] Whether the attachment should be marked as a spoiler | ||
| * @returns {AttachmentBuilder} This attachment | ||
| */ | ||
| setSpoiler(spoiler = true) { | ||
| if (spoiler === this.spoiler) return this; | ||
|
|
||
| if (!spoiler) { | ||
| while (this.spoiler) { | ||
| this.name = this.name.slice('SPOILER_'.length); | ||
| } | ||
| return this; | ||
| } | ||
| this.name = `SPOILER_${this.name}`; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Whether or not this attachment has been marked as a spoiler | ||
| * @type {boolean} | ||
| * @readonly | ||
| */ | ||
| get spoiler() { | ||
| return Util.basename(this.name).startsWith('SPOILER_'); | ||
| } | ||
|
|
||
| toJSON() { | ||
| return Util.flatten(this); | ||
| } | ||
|
|
||
| /** | ||
| * Makes a new builder instance from a preexisting attachment structure. | ||
| * @param {JSONEncodable<AttachmentPayload>} other The builder to construct a new instance from | ||
| * @returns {AttachmentBuilder} | ||
| */ | ||
| static from(other) { | ||
| return new AttachmentBuilder(other.attachment, { | ||
| name: other.name, | ||
| description: other.description, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| module.exports = AttachmentBuilder; | ||
|
|
||
| /** | ||
| * @external APIAttachment | ||
| * @see {@link https://discord.com/developers/docs/resources/channel#attachment-object} | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.