mirror of
https://github.com/discordjs/discord.js.git
synced 2026-06-03 01:20:07 +00:00
8f375275ca
* fix: message builders
- Added `clearParse`, `clearRoles`, and `clearUsers` methods to the `AllowedMentionsBuilder`, since passing an empty array and omitting the these fields behave differently
- Strictened assertions
- Removed `AttachmentBuilder#clearId`, as it is a required field
- Added missing `MessageBuilder#setEmbeds`
- Added missing `MessageReferenceBuilder#setFailIfNotExists`
- Improve/fix documentation
- Consistency™️
* fix: updater functions return type
---------
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
109 lines
2.9 KiB
TypeScript
109 lines
2.9 KiB
TypeScript
import type { JSONEncodable } from '@discordjs/util';
|
|
import type { MessageReferenceType, RESTAPIMessageReference, Snowflake } from 'discord-api-types/v10';
|
|
import { validate } from '../util/validation.js';
|
|
import { messageReferencePredicate } from './Assertions.js';
|
|
|
|
/**
|
|
* A builder that creates API-compatible JSON data for message references.
|
|
*/
|
|
export class MessageReferenceBuilder implements JSONEncodable<RESTAPIMessageReference> {
|
|
private readonly data: Partial<RESTAPIMessageReference>;
|
|
|
|
/**
|
|
* Creates a new message reference builder from API data.
|
|
*
|
|
* @param data - The API data to create this message reference builder with
|
|
*/
|
|
public constructor(data: Partial<RESTAPIMessageReference> = {}) {
|
|
this.data = structuredClone(data);
|
|
}
|
|
|
|
/**
|
|
* Sets the type of message reference this represents
|
|
*
|
|
* @param type - The type of message reference
|
|
*/
|
|
public setType(type: MessageReferenceType): this {
|
|
this.data.type = type;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Clear the type of message reference this represents
|
|
*/
|
|
public clearType(): this {
|
|
this.data.type = undefined;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the id of the message being referenced
|
|
*
|
|
* @param messageId - The id of the message being referenced
|
|
*/
|
|
public setMessageId(messageId: Snowflake): this {
|
|
this.data.message_id = messageId;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the id of the channel being referenced
|
|
*
|
|
* @param channelId - The id of the channel being referenced
|
|
*/
|
|
public setChannelId(channelId: Snowflake): this {
|
|
this.data.channel_id = channelId;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Clear the id of the channel being referenced
|
|
*/
|
|
public clearChannelId(): this {
|
|
this.data.channel_id = undefined;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the id of the guild being referenced
|
|
*
|
|
* @param guildId - The id of the guild being referenced
|
|
*/
|
|
public setGuildId(guildId: Snowflake): this {
|
|
this.data.guild_id = guildId;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Clear the id of the guild being referenced
|
|
*/
|
|
public clearGuildId(): this {
|
|
this.data.guild_id = undefined;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets whether to fail the message creation if the referenced message does not exist
|
|
*
|
|
* @param failIfNotExists - Whether to fail the message creation if the referenced message does not exist
|
|
*/
|
|
public setFailIfNotExists(failIfNotExists = true): this {
|
|
this.data.fail_if_not_exists = failIfNotExists;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Serializes this builder to API-compatible JSON data.
|
|
*
|
|
* Note that by disabling validation, there is no guarantee that the resulting object will be valid.
|
|
*
|
|
* @param validationOverride - Force validation to run/not run regardless of your global preference
|
|
*/
|
|
public toJSON(validationOverride?: boolean): RESTAPIMessageReference {
|
|
const clone = structuredClone(this.data);
|
|
validate(messageReferencePredicate, clone, validationOverride);
|
|
|
|
return clone as RESTAPIMessageReference;
|
|
}
|
|
}
|