feat: export some types so they render in docs (#211)

Co-authored-by: Noel <icrawltogo@gmail.com>

src/DataStore.ts

@@ -49,8 +49,20 @@ export function getGroups() {
 	return groups;
 }
 
+/**
+ * Retrieves all the voice connections under the 'default' group.
+ * @param group - The group to look up
+ * @returns The map of voice connections
+ */
 export function getVoiceConnections(group?: 'default'): Map<string, VoiceConnection>;
+
+/**
+ * Retrieves all the voice connections under the given group name.
+ * @param group - The group to look up
+ * @returns The map of voice connections
+ */
 export function getVoiceConnections(group: string): Map<string, VoiceConnection> | undefined;
+
 /**
  * Retrieves all the voice connections under the given group name. Defaults to the 'default' group.
  * @param group - The group to look up

src/audio/AudioResource.ts

@@ -9,7 +9,7 @@ import { AudioPlayer, SILENCE_FRAME } from './AudioPlayer';
  *
  * @template T - the type for the metadata (if any) of the audio resource.
  */
-interface CreateAudioResourceOptions<T> {
+export interface CreateAudioResourceOptions<T> {
 	/**
 	 * The type of the input stream. Defaults to `StreamType.Arbitrary`.
 	 */
@@ -189,6 +189,21 @@ export function inferStreamType(stream: Readable): {
 	return { streamType: StreamType.Arbitrary, hasVolume: false };
 }
 
+/**
+ * Creates an audio resource that can be played by audio players.
+ *
+ * @remarks
+ * If the input is given as a string, then the inputType option will be overridden and FFmpeg will be used.
+ *
+ * If the input is not in the correct format, then a pipeline of transcoders and transformers will be created
+ * to ensure that the resultant stream is in the correct format for playback. This could involve using FFmpeg,
+ * Opus transcoders, and Ogg/WebM demuxers.
+ *
+ * @param input - The resource to play.
+ * @param options - Configurable options for creating the resource.
+ *
+ * @template T - the type for the metadata (if any) of the audio resource.
+ */
 export function createAudioResource<T>(
 	input: string | Readable,
 	options: CreateAudioResourceOptions<T> &
@@ -198,13 +213,28 @@ export function createAudioResource<T>(
 		>,
 ): AudioResource<T extends null | undefined ? null : T>;
 
+/**
+ * Creates an audio resource that can be played by audio players.
+ *
+ * @remarks
+ * If the input is given as a string, then the inputType option will be overridden and FFmpeg will be used.
+ *
+ * If the input is not in the correct format, then a pipeline of transcoders and transformers will be created
+ * to ensure that the resultant stream is in the correct format for playback. This could involve using FFmpeg,
+ * Opus transcoders, and Ogg/WebM demuxers.
+ *
+ * @param input - The resource to play.
+ * @param options - Configurable options for creating the resource.
+ *
+ * @template T - the type for the metadata (if any) of the audio resource.
+ */
 export function createAudioResource<T extends null | undefined>(
 	input: string | Readable,
 	options?: Omit<CreateAudioResourceOptions<T>, 'metadata'>,
 ): AudioResource<null>;
 
 /**
- * Creates an audio resource that can be played be audio players.
+ * Creates an audio resource that can be played by audio players.
  *
  * @remarks
  * If the input is given as a string, then the inputType option will be overridden and FFmpeg will be used.

src/audio/index.ts

@@ -14,7 +14,7 @@ export {
 
 export { AudioPlayerError } from './AudioPlayerError';
 
-export { AudioResource, createAudioResource } from './AudioResource';
+export { AudioResource, CreateAudioResourceOptions, createAudioResource } from './AudioResource';
 
 export { PlayerSubscription } from './PlayerSubscription';
 

src/index.ts

@@ -19,4 +19,4 @@ export {
 	VoiceConnectionEvents,
 } from './VoiceConnection';
 
-export { getVoiceConnection, getVoiceConnections, getGroups } from './DataStore';
+export { JoinConfig, getVoiceConnection, getVoiceConnections, getGroups } from './DataStore';

src/receive/index.ts

@@ -1,3 +1,4 @@
 export * from './VoiceReceiver';
 export * from './SSRCMap';
 export * from './AudioReceiveStream';
+export * from './SpeakingMap';