Added build step to auto-generate Documentation pages at the /doc endpoint from JSDoc.

This commit is contained in:
rainbow napkin 2025-09-02 07:11:39 -04:00
parent 944d91377b
commit 7d31cc9e8a
76 changed files with 237042 additions and 5 deletions

View file

@ -183,7 +183,7 @@ module.exports = class{
/**
* Validates client requests to change default titles for a given playlist
* @param {Object} data - Data handed over from the client
* @returns
* @returns {Array} Array of strings containing valid titles from the output
*/
changeDefaultTitlesValidator(data){
//Create empty array to hold titles

View file

@ -57,7 +57,7 @@ module.exports = class extends media{
* @param {media} media - Media object to queue
* @param {Number} startTime - Start time formatted as a JS Epoch
* @param {Number} startTimeStamp - Start time stamp in seconds
* @returns
* @returns {queuedMedia} queuedMedia object created from given media object
*/
static fromMedia(media, startTime, startTimeStamp){
//Create and return queuedMedia object from given media object and arguments
@ -75,7 +75,7 @@ module.exports = class extends media{
/**
* Converts array of media objects into array of queuedMedia objects
* @param {[media]} mediaList - Array of media objects to queue
* @param {Array} mediaList - Array of media objects to queue
* @param {Number} start - Start time formatted as JS Epoch
* @returns Array of converted queued media objects
*/

View file

@ -26,7 +26,7 @@ const ytdlpUtil = require('./ytdlpUtils');
* Checks a given URL and runs the proper metadata fetching function to create a media object from any supported URL
* @param {String} url - URL to yank media against
* @param {String} title - Title to apply to yanked media
* @returns
* @returns {Array} Returns list of yanked media objects on success
*/
module.exports.yankMedia = async function(url, title){
//Get pull type