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
+41 -3
View File
@@ -1,19 +1,55 @@
/*
* ======= • ======= • ======= • ======= • =======• =======
* AniKatoAPI — animeInfo.controller.js
* Repository: https://github.com/Shineii86/AniKatoAPI
*
* @description
* Controller for anime detail information. Extracts full anime
* metadata including title, synopsis, episodes, genres, etc.
* Requires an anime slug as query parameter.
*
* @exports
* getAnimeInfo - Express route handler for GET /api/info
*
* @author Shinei Nouzen
* @license MIT
* ======= • ======= • ======= • ======= • =======• =======
*/
import { extractAnimeInfo } from "../extractors/animeInfo.extractor.js";
import { getCache, setCache } from "../helper/cache.helper.js";
// ══════════════════════════════════════════════════════════════
// CONTROLLER: ANIME INFO
// ══════════════════════════════════════════════════════════════
// ---- FEATURE: Anime detail information endpoint ----
/**
* Handles GET /api/info requests by extracting detailed anime
* information from the source site. Requires 'id' query param.
*
* @param {object} req - Express request object
* @param {object} res - Express response object
* @param {Function} next - Express next middleware function
* @returns {void} Sends JSON response with anime details
*
* @example
* GET /api/info?id=one-piece
* Response: { success: true, results: { title, synopsis, ... } }
*
* @throws {400} If 'id' query parameter is missing
*/
const getAnimeInfo = async (req, res, next) => {
try {
const { id } = req.query;
if (!id) {
return res.status(400).json({ success: false, message: "Anime slug is required" });
}
const cacheKey = `anime_${id}`;
const cached = getCache(cacheKey);
if (cached) {
return res.json({ success: true, results: cached });
}
const data = await extractAnimeInfo(id);
setCache(cacheKey, data);
res.json({ success: true, results: data });
@@ -22,4 +58,6 @@ const getAnimeInfo = async (req, res, next) => {
}
};
export { getAnimeInfo };
export { getAnimeInfo };
// ══════════════════════════════════════════════════════════════ END: animeInfo.controller.js