Skip to content

feat(Queue): typed track user data param for 'add' methods #63

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
execaman merged 1 commit into from
May 18, 2026
+6 −4
Merged

feat(Queue): typed track user data param for 'add' methods #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions src/Queue/Queue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { VoiceState } from "../Voice";
import { FilterManager } from "./index";
import type {
APIPlayer,
CommonUserData,
Exception,
JsonObject,
PlayerUpdateQueryParams,
Expand Down Expand Up @@ -301,7 +302,7 @@ export class Queue<Context extends Record<string, unknown> = QueueContext> {
* @param source track, list of tracks, or playlist
* @param userData Object to shallow merge in all track's user data
*/
add(source: Track | Track[] | Playlist, userData?: JsonObject) {
add<UserData extends JsonObject = CommonUserData>(source: Track | Track[] | Playlist, userData?: UserData) {
if (source instanceof Track) {
Object.assign(source.userData, userData);
this.#tracks.push(source);
Expand All @@ -321,13 +322,14 @@ export class Queue<Context extends Record<string, unknown> = QueueContext> {

/**
* Add related tracks to the queue
* @param refTrack Track to use as reference
* @param refTrack Track to use as reference, leave as `null` or `undefined` for default
* @param userData Object to shallow merge in all track's user data
*/
async addRelated(refTrack?: Track) {
async addRelated<UserData extends JsonObject = CommonUserData>(refTrack?: Track | null, userData?: UserData) {
refTrack ??= this.track ?? this.previousTrack!;
if (!refTrack) throw new Error("The queue is empty and there is no track to refer");
const relatedTracks = await this.player.options.fetchRelatedTracks(this, refTrack);
this.add(relatedTracks);
this.add(relatedTracks, userData);
return relatedTracks;
}

Expand Down
Loading