Skip to content

feat(typings): use readonly arrays in parameters #4692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 13, 2020
Merged

feat(typings): use readonly arrays in parameters #4692

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7dac92d
types: use readonly arrays in parameters
cherryblossom000 Aug 11, 2020
02e0fea
Merge branch 'master' into typings
iCrawl Aug 12, 2020
430fc58
Update index.d.ts
iCrawl Aug 13, 2020
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
56 changes: 30 additions & 26 deletions typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ declare module 'discord.js' {
extra?: MessageOptions | WebhookMessageOptions,
): APIMessage;
public static partitionMessageAdditions(
items: (MessageEmbed | MessageAttachment)[],
items: readonly (MessageEmbed | MessageAttachment)[],
): [MessageEmbed[], MessageAttachment[]];
public static resolveFile(fileLike: BufferResolvable | Stream | FileOptions | MessageAttachment): Promise<object>;
public static transformOptions(
Expand Down Expand Up @@ -692,7 +692,7 @@ declare module 'discord.js' {
public setAFKChannel(afkChannel: ChannelResolvable | null, reason?: string): Promise<Guild>;
public setAFKTimeout(afkTimeout: number, reason?: string): Promise<Guild>;
public setBanner(banner: Base64Resolvable | null, reason?: string): Promise<Guild>;
public setChannelPositions(channelPositions: ChannelPosition[]): Promise<Guild>;
public setChannelPositions(channelPositions: readonly ChannelPosition[]): Promise<Guild>;
public setDefaultMessageNotifications(
defaultMessageNotifications: DefaultMessageNotifications | number,
reason?: string,
Expand All @@ -706,7 +706,7 @@ declare module 'discord.js' {
public setPreferredLocale(preferredLocale: string, reason?: string): Promise<Guild>;
public setPublicUpdatesChannel(publicUpdatesChannel: ChannelResolvable | null, reason?: string): Promise<Guild>;
public setRegion(region: string, reason?: string): Promise<Guild>;
public setRolePositions(rolePositions: RolePosition[]): Promise<Guild>;
public setRolePositions(rolePositions: readonly RolePosition[]): Promise<Guild>;
public setRulesChannel(rulesChannel: ChannelResolvable | null, reason?: string): Promise<Guild>;
public setSplash(splash: Base64Resolvable | null, reason?: string): Promise<Guild>;
public setSystemChannel(systemChannel: ChannelResolvable | null, reason?: string): Promise<Guild>;
Expand Down Expand Up @@ -781,7 +781,7 @@ declare module 'discord.js' {
public fetchInvites(): Promise<Collection<string, Invite>>;
public lockPermissions(): Promise<this>;
public overwritePermissions(
overwrites: OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>,
overwrites: readonly OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>,
reason?: string,
): Promise<this>;
public permissionsFor(memberOrRole: GuildMemberResolvable | RoleResolvable): Readonly<Permissions> | null;
Expand Down Expand Up @@ -1897,9 +1897,13 @@ declare module 'discord.js' {
public emoji: GuildEmoji;
public guild: Guild;
public cache: Collection<Snowflake, Role>;
public add(roleOrRoles: RoleResolvable | RoleResolvable[] | Collection<Snowflake, Role>): Promise<GuildEmoji>;
public set(roles: RoleResolvable[] | Collection<Snowflake, Role>): Promise<GuildEmoji>;
public remove(roleOrRoles: RoleResolvable | RoleResolvable[] | Collection<Snowflake, Role>): Promise<GuildEmoji>;
public add(
roleOrRoles: RoleResolvable | readonly RoleResolvable[] | Collection<Snowflake, Role>,
): Promise<GuildEmoji>;
public set(roles: readonly RoleResolvable[] | Collection<Snowflake, Role>): Promise<GuildEmoji>;
public remove(
roleOrRoles: RoleResolvable | readonly RoleResolvable[] | Collection<Snowflake, Role>,
): Promise<GuildEmoji>;
}

export class GuildManager extends BaseManager<Snowflake, Guild, GuildResolvable> {
Expand Down Expand Up @@ -1932,12 +1936,12 @@ declare module 'discord.js' {
public guild: Guild;

public add(
roleOrRoles: RoleResolvable | RoleResolvable[] | Collection<Snowflake, Role>,
roleOrRoles: RoleResolvable | readonly RoleResolvable[] | Collection<Snowflake, Role>,
reason?: string,
): Promise<GuildMember>;
public set(roles: RoleResolvable[] | Collection<Snowflake, Role>, reason?: string): Promise<GuildMember>;
public set(roles: readonly RoleResolvable[] | Collection<Snowflake, Role>, reason?: string): Promise<GuildMember>;
public remove(
roleOrRoles: RoleResolvable | RoleResolvable[] | Collection<Snowflake, Role>,
roleOrRoles: RoleResolvable | readonly RoleResolvable[] | Collection<Snowflake, Role>,
reason?: string,
): Promise<GuildMember>;
}
Expand Down Expand Up @@ -2039,7 +2043,7 @@ declare module 'discord.js' {
typingCount: number;
awaitMessages(filter: CollectorFilter, options?: AwaitMessagesOptions): Promise<Collection<Snowflake, Message>>;
bulkDelete(
messages: Collection<Snowflake, Message> | MessageResolvable[] | number,
messages: Collection<Snowflake, Message> | readonly MessageResolvable[] | number,
filterOld?: boolean,
): Promise<Collection<Snowflake, Message>>;
createMessageCollector(filter: CollectorFilter, options?: MessageCollectorOptions): MessageCollector;
Expand Down Expand Up @@ -2083,7 +2087,7 @@ declare module 'discord.js' {
name?: string;
url?: string;
type?: ActivityType | number;
shardID?: number | number[];
shardID?: number | readonly number[];
}

type ActivityType = 'PLAYING' | 'STREAMING' | 'LISTENING' | 'WATCHING' | 'CUSTOM_STATUS';
Expand Down Expand Up @@ -2150,11 +2154,11 @@ declare module 'discord.js' {
}

interface AwaitMessagesOptions extends MessageCollectorOptions {
errors?: string[];
errors?: readonly string[];
}

interface AwaitReactionsOptions extends ReactionCollectorOptions {
errors?: string[];
errors?: readonly string[];
}

interface BanOptions {
Expand Down Expand Up @@ -2190,7 +2194,7 @@ declare module 'discord.js' {
parentID?: Snowflake;
rateLimitPerUser?: number;
lockPermissions?: boolean;
permissionOverwrites?: OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>;
permissionOverwrites?: readonly OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>;
}

interface ChannelLogsQueryOptions {
Expand Down Expand Up @@ -2427,7 +2431,7 @@ declare module 'discord.js' {
}

interface FetchMembersOptions {
user?: UserResolvable | UserResolvable[];
user?: UserResolvable | readonly UserResolvable[];
query?: string;
limit?: number;
withPresences?: boolean;
Expand Down Expand Up @@ -2509,7 +2513,7 @@ declare module 'discord.js' {
type GuildChannelResolvable = Snowflake | GuildChannel;

interface GuildCreateChannelOptions {
permissionOverwrites?: OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>;
permissionOverwrites?: readonly OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>;
topic?: string;
type?: Exclude<
keyof typeof ChannelType | ChannelType,
Expand Down Expand Up @@ -2554,13 +2558,13 @@ declare module 'discord.js' {
}

interface GuildEmojiCreateOptions {
roles?: Collection<Snowflake, Role> | RoleResolvable[];
roles?: Collection<Snowflake, Role> | readonly RoleResolvable[];
reason?: string;
}

interface GuildEmojiEditData {
name?: string;
roles?: Collection<Snowflake, Role> | RoleResolvable[];
roles?: Collection<Snowflake, Role> | readonly RoleResolvable[];
}

type GuildFeatures =
Expand All @@ -2580,7 +2584,7 @@ declare module 'discord.js' {

interface GuildMemberEditData {
nick?: string;
roles?: Collection<Snowflake, Role> | RoleResolvable[];
roles?: Collection<Snowflake, Role> | readonly RoleResolvable[];
mute?: boolean;
deaf?: boolean;
channel?: ChannelResolvable | null;
Expand Down Expand Up @@ -2707,8 +2711,8 @@ declare module 'discord.js' {
url?: string;
timestamp?: Date | number;
color?: ColorResolvable;
fields?: EmbedFieldData[];
files?: (MessageAttachment | string | FileOptions)[];
fields?: readonly EmbedFieldData[];
files?: readonly (MessageAttachment | string | FileOptions)[];
author?: Partial<MessageEmbedAuthor> & { icon_url?: string; proxy_icon_url?: string };
thumbnail?: Partial<MessageEmbedThumbnail> & { proxy_url?: string };
image?: Partial<MessageEmbedImage> & { proxy_url?: string };
Expand Down Expand Up @@ -2758,7 +2762,7 @@ declare module 'discord.js' {
embed?: MessageEmbed | MessageEmbedOptions;
disableMentions?: 'none' | 'all' | 'everyone';
allowedMentions?: MessageMentionOptions;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
files?: readonly (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
code?: string | boolean;
split?: boolean | SplitOptions;
reply?: UserResolvable;
Expand Down Expand Up @@ -2845,7 +2849,7 @@ declare module 'discord.js' {
| 'MANAGE_WEBHOOKS'
| 'MANAGE_EMOJIS';

interface RecursiveArray<T> extends Array<T | RecursiveArray<T>> {}
interface RecursiveArray<T> extends ReadonlyArray<T | RecursiveArray<T>> {}

type RecursiveReadonlyArray<T> = ReadonlyArray<T | RecursiveReadonlyArray<T>>;

Expand Down Expand Up @@ -3081,10 +3085,10 @@ declare module 'discord.js' {
avatarURL?: string;
tts?: boolean;
nonce?: string;
embeds?: (MessageEmbed | object)[];
embeds?: readonly (MessageEmbed | object)[];
disableMentions?: 'none' | 'all' | 'everyone';
allowedMentions?: MessageMentionOptions;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
files?: readonly (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
code?: string | boolean;
split?: boolean | SplitOptions;
}
Expand Down