DisTubeEvents is not array-based like ClientEvents in discord.js

[Majoramari]

Please describe your problem in as much detail as possible:

// ClientEvents is array-based
export interface ClientEvents {
    // ...
    interactionCreate: [interaction: Interaction];
}
// ClientEvents is functional-based
declare type DisTubeEvents = {
    // ...
    initQueue: (queue: Queue) => Awaitable;
};

Why this might be an issue?
You can't migrate DisTubeEvents with ClientEvents into one Event handler natively, you will have to declare your own type array-based like this:

type CustomEvents = {
  error: [channel: GuildTextBasedChannel | undefined, error: Error];
  addList: [queue: Queue, playlist: Playlist];
  addSong: [queue: Queue, song: Song];
  playSong: [queue: Queue, song: Song];
  finishSong: [queue: Queue, song: Song];
  empty: [queue: Queue];
  finish: [queue: Queue];
  initQueue: [queue: Queue];
  noRelated: [queue: Queue];
  disconnect: [queue: Queue];
  deleteQueue: [queue: Queue];
  searchCancel: [message: Message<true>, query: string];
  searchNoResult: [message: Message<true>, query: string];
  searchDone: [message: Message<true>, answer: Message<true>, query: string];
  searchInvalidAnswer: [message: Message<true>, answer: Message<true>, query: string];
  searchResult: [message: Message<true>, results: SearchResult[], query: string];
} & ClientEvents;

As far as I see DisTube is meant to complete discord.js to work with it so I suggest converting DisTubeEvents to be array-based like ClientEvents

Further information:

• DisTube version: 4.0.2
• discord.js version: 14.0.3
• Node.js version: 16.16.0
• Operating system: Windows 11 Pro

[skick1234]

I will convert to this later.

Workaround of your CustomEvents

type CustomEvents = {
    [K in keyof DisTubeEvents]: Parameters<DisTubeEvents[K]>;
} & ClientEvents;

[Majoramari]

Just use Parameters<DisTubeEvents.error> or ClientEvents.error when you extend you event class.

Sorry about my lack of knowledge on this topic but it's not clear to me exactly how Parameters<DisTubeEvents.error> is working do you mean like this?

export type CustomEvents = {
  [K in keyof DisTubeEvents]: Parameters<DisTubeEvents[K]>;
} & ClientEvents & Parameters<DisTubeEvents.error> // <-- do you mean like this?;

[Majoramari]

Yes, because your event handler doesn't know what event for what emitter. Like CustomEvents.error can be both DisTube and Client listener.

Also, the only conflicting event is an error, why not rename it to something else like PlayerError or something?

[skick1234]

Also, the only conflicting event is an error, why not rename it to something else like PlayerError or something?

Because your merge is wrong, not related to DisTube or Client types.

export type DTEvents = {
    [K in keyof DisTubeEvents]: Parameters<DisTubeEvents[K]>;
};

type Merge<T, U> = Omit<U, keyof T> & {
    [K in keyof T]: K extends keyof U ? T[K] | U[K] : T[K];
} extends infer O
    ? { [K in keyof O]: O[K] }
    : never;

type CustomEvents = Merge<ClientEvents, DTEvents>;

[skick1234]

Why not rename error event?

1. This is Node.js standard (https://nodejs.org/api/events.html#error-events)
2. DisTube is not Discordjs.Client or its extended version
3. Merging those types is not necessary. You should handle those events separately.

[Majoramari]

Understandable, thanks for the explanation, I'll handle the events separately if it's the right way...