style: Add full doc comments to proxy.js, server.js, test.js, api/index.js

- Box-style header with project/author/license
- Section headers (═══ SECTION ═══)
- Function-level JSDoc (purpose, params, returns, examples)
- Inline notes for non-obvious logic
- Feature markers (---- FEATURE: XYZ ----)
- Footer on every module
This commit is contained in:
Sʜɪɴᴇɪ Nᴏᴜᴢᴇɴ
2026-06-25 10:55:48 +05:30
parent 16eb0236d7
commit 156f9b16a5
4 changed files with 292 additions and 40 deletions
+28
View File
@@ -183,9 +183,37 @@ app.get("/docs", (req, res) => {
// RESPONSE HELPERS
// ══════════════════════════════════════════════════════════════
// ---- FEATURE: Response helper — wrap data in standard success format ----
/**
* Wraps data in the standard API success response format.
* All successful responses follow: { success: true, results: data }
*
* @param {import('express').Response} res - Express response object
* @param {any} data - The data to wrap
* @param {number} [status=200] - HTTP status code
* @returns {import('express').Response} Express response with JSON body
*
* @example
* jsonResponse(res, { anime: [...] });
* // => { "success": true, "results": { "anime": [...] } }
*/
const jsonResponse = (res, data, status = 200) =>
res.status(status).json({ success: true, results: data });
// ---- FEATURE: Error helper — wrap message in standard error format ----
/**
* Wraps an error message in the standard API error response format.
* All error responses follow: { success: false, message: "..." }
*
* @param {import('express').Response} res - Express response object
* @param {string} [message="Internal server error"] - Error description
* @param {number} [status=500] - HTTP status code
* @returns {import('express').Response} Express response with JSON error body
*
* @example
* jsonError(res, "Anime not found", 404);
* // => { "success": false, "message": "Anime not found" }
*/
const jsonError = (res, message = "Internal server error", status = 500) =>
res.status(status).json({ success: false, message });