Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-18 12:33:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

typings: Make activity name required (#9765)

Browse Source 
* fix: activity name is required

* chore: add suggested changes

Co-authored-by: Aura Román <kyradiscord@gmail.com>

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Co-authored-by: Aura Román <kyradiscord@gmail.com>
This commit is contained in:
Jaw0r3k
2023-08-12 13:12:33 +02:00
committed by GitHub
parent 346fa57f95
commit 0a9a3ede29
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/discord.js/src/structures/ClientUser.js
View File

@@ -98,7 +98,7 @@ class ClientUser extends User {
/** /**
* Options for setting activities * Options for setting activities
* @typedef {Object} ActivitiesOptions * @typedef {Object} ActivitiesOptions
* @property {string} [name] Name of the activity * @property {string} name Name of the activity
* @property {ActivityType} [type] Type of the activity * @property {ActivityType} [type] Type of the activity
* @property {string} [url] Twitch / YouTube stream URL * @property {string} [url] Twitch / YouTube stream URL
*/ */
@@ -149,7 +149,7 @@ class ClientUser extends User {
/** /**
* Options for setting an activity. * Options for setting an activity.
* @typedef {Object} ActivityOptions * @typedef {Object} ActivityOptions
* @property {string} [name] Name of the activity * @property {string} name Name of the activity
* @property {string} [url] Twitch / YouTube stream URL * @property {string} [url] Twitch / YouTube stream URL
* @property {ActivityType} [type] Type of the activity * @property {ActivityType} [type] Type of the activity
* @property {number|number[]} [shardId] Shard Id(s) to have the activity set on * @property {number|number[]} [shardId] Shard Id(s) to have the activity set on
@@ -157,7 +157,7 @@ class ClientUser extends User {
/** /**
* Sets the activity the client user is playing. * Sets the activity the client user is playing.
* @param {string|ActivityOptions} [name] Activity being played, or options for setting the activity * @param {string|ActivityOptions} name Activity being played, or options for setting the activity
* @param {ActivityOptions} [options] Options for setting the activity * @param {ActivityOptions} [options] Options for setting the activity
* @returns {ClientPresence} * @returns {ClientPresence}
* @example * @example

4
packages/discord.js/typings/index.d.ts vendored
View File

@@ -1044,7 +1044,7 @@ export class ClientUser extends User {
public verified: boolean; public verified: boolean;
public edit(options: ClientUserEditOptions): Promise<this>; public edit(options: ClientUserEditOptions): Promise<this>;
public setActivity(options?: ActivityOptions): ClientPresence; public setActivity(options?: ActivityOptions): ClientPresence;
public setActivity(name: string, options?: ActivityOptions): ClientPresence; public setActivity(name: string, options?: Omit<ActivityOptions, 'name'>): ClientPresence;
public setAFK(afk?: boolean, shardId?: number | number[]): ClientPresence; public setAFK(afk?: boolean, shardId?: number | number[]): ClientPresence;
public setAvatar(avatar: BufferResolvable | Base64Resolvable | null): Promise<this>; public setAvatar(avatar: BufferResolvable | Base64Resolvable | null): Promise<this>;
public setPresence(data: PresenceData): ClientPresence; public setPresence(data: PresenceData): ClientPresence;
@@ -4322,7 +4322,7 @@ export interface WebhookFields extends PartialWebhookFields {
export type ActivitiesOptions = Omit<ActivityOptions, 'shardId'>; export type ActivitiesOptions = Omit<ActivityOptions, 'shardId'>;
export interface ActivityOptions { export interface ActivityOptions {
name?: string; name: string;
url?: string; url?: string;
type?: Exclude<ActivityType, ActivityType.Custom>; type?: Exclude<ActivityType, ActivityType.Custom>;
shardId?: number | readonly number[]; shardId?: number | readonly number[];