Refactor: Improve type annotations

EvandroLG · Jan 25, 2025 · 038e8b3 · 038e8b3
1 parent fdcee42
commit 038e8b3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/src/playlist/playAudio.ts b/src/playlist/playAudio.ts
@@ -10,7 +10,10 @@ import Audio from '../audio/Audio'
  * @param {EventEmitter} emmiter - Event emitter for handling playlist events
  * @returns {(files: string[], loop: boolean) => void} A function that handles audio playback
  */
-const playAudio = (states: AudioPlaylistState, emmiter: EventEmitter) => {
+const playAudio = (
+  states: AudioPlaylistState,
+  emmiter: EventEmitter,
+): ((files: string[], loop: boolean) => void) => {
   const playAudioHelper = (files: string[], loop: boolean) => {
     const file = files[states.audioIndex]
     const audio = Audio({ file, volume: states.volume })

diff --git a/src/playlist/states.ts b/src/playlist/states.ts
@@ -1,5 +1,8 @@
 import type { AudioType } from '../audio/types'
 
+/**
+ * Represents the global state for an audio playlist.
+ */
 export type AudioPlaylistState = {
   volume: number
   loop: boolean
@@ -9,6 +12,9 @@ export type AudioPlaylistState = {
   audioIndex: number
 }
 
+/**
+ * Default initial state for the audio playlist.
+ */
 const states: AudioPlaylistState = {
   volume: 1,
   loop: false,