v1.5.0: Complete documentation rewrite - 50+ files with AlisaReactionBot style

- Box-style header comments (Project, Author, License) on every file
- Section headers using double-line box decorators
- Feature markers (// ---- FEATURE: XYZ ----) before every major function
- JSDoc comments for EVERY function with @param, @returns, @example
- Inline notes (NOTE, WARNING, TIP) for non-obvious logic
- Footer END markers on every module
- Matched code style to AlisaReactionBot repository
- All files now searchable by feature name via grep

Author: Shinei Nouzen <157171073+Shineii86@users.noreply.github.com>
This commit is contained in:
Sʜɪɴᴇɪ Nᴏᴜᴢᴇɴ
2026-06-08 16:14:01 +05:30
parent 87d6d4dbf2
commit 0034617c3b
55 changed files with 2965 additions and 108 deletions
+44 -4
View File
@@ -1,20 +1,58 @@
/*
* ======= • ======= • ======= • ======= • =======• =======
* AniKatoAPI — watchPage.controller.js
* Repository: https://github.com/Shineii86/AniKatoAPI
*
* @description
* Controller for the watch page endpoint. Returns episode
* details, video player data, and related anime information.
* Requires both 'slug' and 'ep' query parameters.
*
* @exports
* getWatchPage - Express route handler for GET /api/watch
*
* @author Shinei Nouzen
* @license MIT
* ======= • ======= • ======= • ======= • =======• =======
*/
import { extractWatchPage } from "../extractors/watchPage.extractor.js";
import { getCache, setCache } from "../helper/cache.helper.js";
// ══════════════════════════════════════════════════════════════
// CONTROLLER: WATCH PAGE
// ══════════════════════════════════════════════════════════════
// ---- FEATURE: Watch page data endpoint ----
/**
* Handles GET /api/watch requests. Returns episode data and
* player information for the specified anime and episode.
*
* @param {object} req - Express request object
* @param {string} req.query.slug - Anime slug identifier
* @param {string|number} req.query.ep - Episode number
* @param {object} res - Express response object
* @param {Function} next - Express next middleware function
* @returns {void} Sends JSON response with watch page data
*
* @example
* GET /api/watch?slug=one-piece&ep=1
* Response: { success: true, results: { episode, servers, ... } }
*
* @throws {400} If 'slug' or 'ep' query parameters are missing
* WARNING: Both slug and ep are required or the endpoint returns 500
*/
const getWatchPage = async (req, res, next) => {
try {
const { slug, ep } = req.query;
if (!slug || !ep) {
return res.status(400).json({ success: false, message: "Slug and episode number are required" });
}
const cacheKey = `watch_${slug}_${ep}`;
const cached = getCache(cacheKey);
if (cached) {
return res.json({ success: true, results: cached });
}
const data = await extractWatchPage(slug, ep);
setCache(cacheKey, data);
res.json({ success: true, results: data });
@@ -23,4 +61,6 @@ const getWatchPage = async (req, res, next) => {
}
};
export { getWatchPage };
export { getWatchPage };
// ══════════════════════════════════════════════════════════════ END: watchPage.controller.js