Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/structures/src/channels/mixins/ChannelPinMixin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* use `Object.defineProperties`. To override the defaults, set this value directly.
* use `Object.defineProperties`.

*/
public static readonly DataTemplate: Partial<
ChannelDataType<ChannelType.DM | ChannelType.GuildAnnouncement | ChannelType.GuildText | ThreadChannelType>
Expand Down
5 changes: 4 additions & 1 deletion packages/structures/src/messages/Message.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ export class Message<Omitted extends keyof APIMessage | '' = 'edited_timestamp'
Omitted
> {
/**
* 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* use `Object.defineProperties`. To override the defaults, set this value directly.
* use `Object.defineProperties`.

*/
public static override DataTemplate: Partial<APIMessage> = {
set timestamp(_: string) {},
Expand Down
5 changes: 4 additions & 1 deletion packages/structures/src/messages/MessageCall.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ export class MessageCall<Omitted extends keyof APIMessageCall | '' = 'ended_time
Omitted
> {
/**
* The template used for removing data from the raw data stored for each MessageCall
* The template used for removing data from the raw data stored for each MessageCall.
*
* @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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* use `Object.defineProperties`. To override the defaults, set this value directly.
* use `Object.defineProperties`.

*/
public static override DataTemplate: Partial<APIMessageCall> = {
set ended_timestamp(_: string) {},
Expand Down
3 changes: 3 additions & 0 deletions packages/structures/src/messages/Reaction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import type { Partialize } from '../utils/types.js';
export class Reaction<Omitted extends keyof APIReaction | '' = ''> extends Structure<APIReaction, Omitted> {
/**
* 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* use `Object.defineProperties`. To override the defaults, set this value directly.
* use `Object.defineProperties`.

*/
public static override DataTemplate: Partial<APIReaction> = {
set burst_colors(_: string[]) {},
Expand Down
3 changes: 3 additions & 0 deletions packages/structures/src/messages/embeds/Embed.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ import type { Partialize } from '../../utils/types.js';
export class Embed<Omitted extends keyof APIEmbed | '' = ''> extends Structure<APIEmbed, Omitted> {
/**
* 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* use `Object.defineProperties`. To override the defaults, set this value directly.
* use `Object.defineProperties`.

*/
public static override readonly DataTemplate: Partial<APIEmbed> = {
set timestamp(_: string) {},
Expand Down
2 changes: 1 addition & 1 deletion packages/structures/src/users/User.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type { Partialize } from '../utils/types.js';
*/
export class User<Omitted extends keyof APIUser | '' = ''> extends Structure<APIUser, Omitted> {
/**
* 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<APIUser> = {};

Expand Down