diff --git a/packages/structures/src/channels/mixins/ChannelPinMixin.ts b/packages/structures/src/channels/mixins/ChannelPinMixin.ts index d82051c14b4d..a5df9599a1a7 100644 --- a/packages/structures/src/channels/mixins/ChannelPinMixin.ts +++ b/packages/structures/src/channels/mixins/ChannelPinMixin.ts @@ -16,6 +16,9 @@ export class ChannelPinMixin< /** * The template used for removing data from the raw data stored for each Channel. + * + * @remarks This template has defaults, if you want to remove additional data and keep the defaults, + * use `Object.defineProperties`. To override the defaults, set this value directly. */ public static readonly DataTemplate: Partial< ChannelDataType diff --git a/packages/structures/src/messages/Message.ts b/packages/structures/src/messages/Message.ts index 7fa33895def5..715ea0c74933 100644 --- a/packages/structures/src/messages/Message.ts +++ b/packages/structures/src/messages/Message.ts @@ -20,7 +20,10 @@ export class Message { /** - * The template used for removing data from the raw data stored for each Message + * The template used for removing data from the raw data stored for each Message. + * + * @remarks This template has defaults, if you want to remove additional data and keep the defaults, + * use `Object.defineProperties`. To override the defaults, set this value directly. */ public static override DataTemplate: Partial = { set timestamp(_: string) {}, diff --git a/packages/structures/src/messages/MessageCall.ts b/packages/structures/src/messages/MessageCall.ts index 67c316b02d2c..c724401cdcc1 100644 --- a/packages/structures/src/messages/MessageCall.ts +++ b/packages/structures/src/messages/MessageCall.ts @@ -9,7 +9,10 @@ export class MessageCall extends Structure { /** * The template used for removing data from the raw data stored for each Reaction. + * + * @remarks This template has defaults, if you want to remove additional data and keep the defaults, + * use `Object.defineProperties`. To override the defaults, set this value directly. */ public static override DataTemplate: Partial = { set burst_colors(_: string[]) {}, diff --git a/packages/structures/src/messages/embeds/Embed.ts b/packages/structures/src/messages/embeds/Embed.ts index dad829324496..fd0c48ebbea8 100644 --- a/packages/structures/src/messages/embeds/Embed.ts +++ b/packages/structures/src/messages/embeds/Embed.ts @@ -13,6 +13,9 @@ import type { Partialize } from '../../utils/types.js'; export class Embed extends Structure { /** * The template used for removing data from the raw data stored for each Embed. + * + * @remarks This template has defaults, if you want to remove additional data and keep the defaults, + * use `Object.defineProperties`. To override the defaults, set this value directly. */ public static override readonly DataTemplate: Partial = { set timestamp(_: string) {}, diff --git a/packages/structures/src/users/User.ts b/packages/structures/src/users/User.ts index da6d18be713c..2a9404622d51 100644 --- a/packages/structures/src/users/User.ts +++ b/packages/structures/src/users/User.ts @@ -13,7 +13,7 @@ import type { Partialize } from '../utils/types.js'; */ export class User extends Structure { /** - * The template used for removing data from the raw data stored for each User + * The template used for removing data from the raw data stored for each User. */ public static override readonly DataTemplate: Partial = {};