Finished JSDoc for src/schemas/channel/media

This commit is contained in:
rainbow napkin 2025-09-01 23:14:16 -04:00
parent b78d35d0f8
commit ec37c2f59d
4 changed files with 49 additions and 3 deletions

View file

@ -21,6 +21,9 @@ const {mongoose} = require('mongoose');
const mediaSchema = require('./mediaSchema');
const queuedMedia = require('../../../app/channel/media/queuedMedia');
/**
* DB Schema for documents representing a queued media object
*/
const queuedProperties = new mongoose.Schema({
startTime: {
type: mongoose.SchemaTypes.Number,
@ -44,7 +47,10 @@ const queuedProperties = new mongoose.Schema({
});
//Methods
//Rehydrate to a full phat queued media object
/**
* Rehydrate to a full phat queued media object
* @returns {queuedMedia} A full phat queued media object, re-hydrated from the DB
*/
queuedProperties.methods.rehydrate = function(){
return new queuedMedia(
this.title,