docs: better code comments + intellisense for Lavalink structures

src/Utils.ts

@@ -25,6 +25,20 @@ export abstract class TypedEventEmitter<T extends Record<string, unknown[]>> ext
 
 export type Constructor<T> = new (...args: unknown[]) => T;
 
+export type OmitNested<I extends object, K extends keyof I, T extends keyof NonNullable<I[K]>> = {
+	[key in keyof I]: key extends K ? Omit<I[key], T> : I[key];
+};
+
+// https://github.com/microsoft/TypeScript/issues/43505#issuecomment-1686128430
+export type NumericRange<
+	start extends number,
+	end extends number,
+	arr extends unknown[] = [],
+	acc extends number = never
+> = arr['length'] extends end
+	? acc | start | end
+	: NumericRange<start, end, [...arr, 1], arr[start] extends undefined ? acc : acc | arr['length']>;
+
 /**
  * Merge the default options to user input
  * @param def Default options

src/guild/Connection.ts

@@ -4,20 +4,43 @@ import { Shoukaku, VoiceChannelOptions } from '../Shoukaku';
 
 /**
  * Represents the partial payload from a stateUpdate event
+ * @see https://discord.com/developers/docs/resources/voice#voice-state-object
  */
 export interface StateUpdatePartial {
+	/**
+     * Channel ID the state update is for
+     */
 	channel_id?: string;
+	/**
+     * Session ID the state update is for
+     */
 	session_id?: string;
+	/**
+     * Whether this user is locally deafened
+     */
 	self_deaf: boolean;
+	/**
+     * Whether this user is locally muted
+     */
 	self_mute: boolean;
 }
 
 /**
  * Represents the payload from a serverUpdate event
+ * @see https://discord.com/developers/docs/topics/gateway-events#voice-server-update
  */
 export interface ServerUpdate {
+	/**
+     * Voice connection token
+     */
 	token: string;
+	/**
+     * Guild this voice server update is for
+     */
 	guild_id: string;
+	/**
+     * Voice server hostname
+     */
 	endpoint: string;
 }