Skip to content
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

Jump to bottom

fix(typings): return types for 'Webhook(Client)#send()' #4876

Merged
merged 6 commits into from
Jan 22, 2021
Merged

fix(typings): return types for 'Webhook(Client)#send()' #4876

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ae758a8
feat(Typings): add 'APIRawMessage' interface
izexi Oct 2, 2020
c2bc87c
fix(Typings): return type for WebhookFields#send()
izexi Oct 2, 2020
d592778
fix(Typings): types for APIRawMessage props
izexi Oct 2, 2020
dea21c2
refactor(Typings): exclude oauth props from API
izexi Oct 2, 2020
806634b
feat(Typings): add WebhookRawMessageResponse type
izexi Oct 2, 2020
30b91b1
refactor(Typings): use WebhookRawMessageResponse
izexi Oct 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
118 changes: 112 additions & 6 deletions typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2097,18 +2097,25 @@ declare module 'discord.js' {
edit(options: WebhookEditData): Promise<Webhook>;
send(
content: APIMessageContentResolvable | (WebhookMessageOptions & { split?: false }) | MessageAdditions,
): Promise<Message>;
send(options: WebhookMessageOptions & { split: true | SplitOptions }): Promise<Message[]>;
send(options: WebhookMessageOptions | APIMessage): Promise<Message | Message[]>;
): Promise<Message | WebhookRawMessageResponse>;
send(
options: WebhookMessageOptions & { split: true | SplitOptions },
): Promise<(Message | WebhookRawMessageResponse)[]>;
send(
options: WebhookMessageOptions | APIMessage,
): Promise<Message | WebhookRawMessageResponse | (Message | WebhookRawMessageResponse)[]>;
send(
content: StringResolvable,
options: (WebhookMessageOptions & { split?: false }) | MessageAdditions,
): Promise<Message>;
): Promise<Message | WebhookRawMessageResponse>;
send(
content: StringResolvable,
options: WebhookMessageOptions & { split: true | SplitOptions },
): Promise<Message[]>;
send(content: StringResolvable, options: WebhookMessageOptions): Promise<Message | Message[]>;
): Promise<(Message | WebhookRawMessageResponse)[]>;
send(
content: StringResolvable,
options: WebhookMessageOptions,
): Promise<Message | WebhookRawMessageResponse | (Message | WebhookRawMessageResponse)[]>;
sendSlackMessage(body: object): Promise<boolean>;
}

Expand Down Expand Up @@ -2184,6 +2191,95 @@ declare module 'discord.js' {

type APIMessageContentResolvable = string | number | boolean | bigint | symbol | readonly StringResolvable[];

interface APIRawMessage {
id: Snowflake;
type: number;
content: string;
channel_id: Snowflake;
author: {
bot?: true;
id: Snowflake;
username: string;
avatar: string | null;
discriminator: string;
};
attachments: {
id: Snowflake;
filename: string;
size: number;
url: string;
proxy_url: string;
height: number | null;
width: number | null;
}[];
embeds: {
title?: string;
type?: 'rich' | 'image' | 'video' | 'gifv' | 'article' | 'link';
description?: string;
url?: string;
timestamp?: string;
color?: number;
footer?: {
text: string;
icon_url?: string;
proxy_icon_url?: string;
};
image?: {
url?: string;
proxy_url?: string;
height?: number;
width?: number;
};
thumbnail?: {
url?: string;
proxy_url?: string;
height?: number;
width?: number;
};
video?: {
url?: string;
height?: number;
width?: number;
};
provider?: { name?: string; url?: string };
author?: {
name?: string;
url?: string;
icon_url?: string;
proxy_icon_url?: string;
};
fields?: {
name: string;
value: string;
inline?: boolean;
}[];
}[];
mentions: {
id: Snowflake;
username: string;
discriminator: string;
avatar: string | null;
bot?: true;
public_flags?: number;
member?: {
nick: string | null;
roles: Snowflake[];
joined_at: string;
premium_since?: string | null;
deaf: boolean;
mute: boolean;
};
}[];
mention_roles: Snowflake[];
pinned: boolean;
mention_everyone: boolean;
tts: boolean;
timestamp: string;
edited_timestamp: string | null;
flags: number;
webhook_id: Snowflake;
}

interface ApplicationAsset {
name: string;
id: Snowflake;
Expand Down Expand Up @@ -3187,6 +3283,16 @@ declare module 'discord.js' {
split?: boolean | SplitOptions;
}

type WebhookRawMessageResponse = Omit<APIRawMessage, 'author'> & {
author: {
bot: true;
id: Snowflake;
username: string;
avatar: string | null;
discriminator: '0000';
};
};

type WebhookTypes = 'Incoming' | 'Channel Follower';

interface WebSocketOptions {
Expand Down