Improve documentation and arg names in TrackProgressMonitor.js

This commit is contained in:
mikiher 2024-07-20 21:42:58 +03:00
parent 75899242fd
commit da51d38ba2

View File

@ -6,8 +6,8 @@ class TrackProgressMonitor {
/** /**
* @callback ProgressCallback * @callback ProgressCallback
* @param {number} trackIndex - The index of the track that is being updated. * @param {number} trackIndex - The index of the current track.
* @param {number} progressInTrack - The progress of the track in percent. * @param {number} progressInTrack - The current track progress in percent.
* @param {number} totalProgress - The total progress in percent. * @param {number} totalProgress - The total progress in percent.
*/ */
@ -59,9 +59,9 @@ class TrackProgressMonitor {
this.trackStartedCallback(this.currentTrackIndex) this.trackStartedCallback(this.currentTrackIndex)
} }
#progressUpdated(progress) { #progressUpdated(totalProgress) {
const progressInTrack = (this.currentTrackProgress / this.currentTrackPercentage) * 100 const progressInTrack = (this.currentTrackProgress / this.currentTrackPercentage) * 100
this.progressCallback(this.currentTrackIndex, progressInTrack, progress) this.progressCallback(this.currentTrackIndex, progressInTrack, totalProgress)
} }
#trackFinished() { #trackFinished() {
@ -69,12 +69,12 @@ class TrackProgressMonitor {
} }
/** /**
* Updates the progress of the track. * Updates the track progress based on the total progress.
* @param {number} progress - The progress of the track in percent. * @param {number} totalProgress - The total progress in percent.
*/ */
update(progress) { update(totalProgress) {
while (this.#outsideCurrentTrack(progress) && !this.allTracksFinished) this.#moveToNextTrack() while (this.#outsideCurrentTrack(totalProgress) && !this.allTracksFinished) this.#moveToNextTrack()
if (!this.allTracksFinished) this.#progressUpdated(progress) if (!this.allTracksFinished) this.#progressUpdated(totalProgress)
} }
/** /**