From 038e8b382085d1d246e4b18b4b3b002f64a3d4c0 Mon Sep 17 00:00:00 2001 From: Evandro Leopoldino Goncalves Date: Sat, 25 Jan 2025 12:19:13 +0100 Subject: [PATCH] Refactor: Improve type annotations --- src/playlist/playAudio.ts | 5 ++++- src/playlist/states.ts | 6 ++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/playlist/playAudio.ts b/src/playlist/playAudio.ts index 30d4234..fe98871 100644 --- 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 index 172025d..8bec69c 100644 --- 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,