mirror of
https://github.com/Shineii86/AniKotoAPI.git
synced 2026-10-22 10:55:10 +00:00
docs: Add box-style headers, section headers, feature markers, JSDoc, inline notes, footers
Added comprehensive documentation following project conventions: Box-style headers (added/fixed where missing): - All 17 files now have standard Project/Author/License headers Section headers (// == == SECTION == ==): - cache.helper.js: LRU CACHE CLASS, TTL CONFIGURATION, SINGLETON, EXPORTED HELPERS - download.controller.js: DOWNLOAD LINKS HANDLER - download.extractor.js: BASE64 DECODER, REDIRECT FOLLOWER, DOWNLOAD LINKS EXTRACTOR - seasons.extractor.js: SEASONS EXTRACTOR - watchOrder.extractor.js: WATCH ORDER EXTRACTOR - extractPages.helper.js: PAGE EXTRACTOR - pagination.helper.js: PAGINATION METADATA Feature markers (// --- FEATURE: XYZ ---): - cache.helper.js: LRU Cache, Per-Endpoint TTL, Cache Get/Set/Clear - download.controller.js: Download Links - download.extractor.js: Base64 Download Data Decoder, Redirect Chain Resolver, Download Links Extraction - seasons.extractor.js: Season Information Extraction - watchOrder.extractor.js: Watch Order / Related Anime Extraction - streamResolver.extractor.js: Server Name Normalization, Stream URL Resolution, Batch Stream URL Resolution, M3U8 Quality Parser, Subtitle Track Extractor - mirror.helper.js: Mirror Domain Configuration, Mirror Health Check, Working Mirror Discovery, Mirror Cache Reset, URL Builder, Resilient Fetch with Mirror Fallback, Mirror Status Reporter - pagination.helper.js: Pagination Metadata Generator - creatorInfo.js: Creator Attribution Object, Response Creator Injection Middleware Function-level JSDoc (added/fixed): - cache.helper.js: Full JSDoc on all 6 class methods (constructor, get, set, delete, clear, getStats, has) and 4 exported helpers Inline notes for non-obvious logic: - cache.helper.js: Lazy expiration, LRU re-insertion, singleton pattern - download.extractor.js: HTML/JSON hybrid response handling, multiple selectors for different mirrors, redirect fallback - random.extractor.js: maxRedirects, validateStatus, responseURL extraction - schedule.extractor.js: Dual selector pattern for different mirror layouts - animeInfo.extractor.js: Positional .bmeta selector fragility - homeInfo.extractor.js: Dual selector for different layouts - mirror.helper.js: 404 vs connection error handling - animeInfo.controller.js: Accept both id and slug params Footers (added where missing): - cache.helper.js, download.controller.js, download.extractor.js, seasons.extractor.js, watchOrder.extractor.js, extractPages.helper.js, mirror.helper.js All 68 source files now have complete documentation coverage (6/6 checks).
This commit is contained in:
@@ -24,6 +24,7 @@ import { getCache, setCache } from "./cache.helper.js";
|
||||
// MIRROR CONFIGURATION
|
||||
// ══════════════════════════════════════════════════════════════
|
||||
|
||||
// ---- FEATURE: Mirror Domain Configuration ----
|
||||
// Default mirrors with names and priority
|
||||
const DEFAULT_MIRRORS = [
|
||||
{ url: "https://anikototv.to", name: "Primary", priority: 1 },
|
||||
@@ -63,6 +64,7 @@ let failedMirrors = new Set();
|
||||
// HELPER FUNCTIONS
|
||||
// ══════════════════════════════════════════════════════════════
|
||||
|
||||
// ---- FEATURE: Mirror Health Check ----
|
||||
/**
|
||||
* Check if a mirror is accessible
|
||||
* @param {string} baseUrl - Mirror base URL
|
||||
@@ -81,6 +83,7 @@ async function checkMirror(baseUrl) {
|
||||
}
|
||||
}
|
||||
|
||||
// ---- FEATURE: Working Mirror Discovery ----
|
||||
/**
|
||||
* Get the best available mirror
|
||||
* @returns {Promise<string>} Working mirror base URL
|
||||
@@ -116,6 +119,7 @@ async function getWorkingMirror() {
|
||||
return workingMirror;
|
||||
}
|
||||
|
||||
// ---- FEATURE: Mirror Cache Reset ----
|
||||
/**
|
||||
* Reset mirror cache and failed state
|
||||
*/
|
||||
@@ -126,6 +130,7 @@ function resetMirrorCache() {
|
||||
console.log("[MIRROR] Cache reset");
|
||||
}
|
||||
|
||||
// ---- FEATURE: URL Builder ----
|
||||
/**
|
||||
* Build URL with current mirror
|
||||
* @param {string} path - URL path
|
||||
@@ -137,6 +142,7 @@ function buildUrl(path, baseUrl = workingMirror) {
|
||||
return `${base}${path}`;
|
||||
}
|
||||
|
||||
// ---- FEATURE: Resilient Fetch with Mirror Fallback ----
|
||||
/**
|
||||
* Fetch with automatic mirror fallback
|
||||
* @param {string} path - URL path to fetch
|
||||
@@ -227,6 +233,7 @@ async function fetchWithMirror(path, options = {}) {
|
||||
throw new Error(`All mirrors failed. Last error: ${lastError?.message}`);
|
||||
}
|
||||
|
||||
// ---- FEATURE: Mirror Status Reporter ----
|
||||
/**
|
||||
* Get mirror status for all domains
|
||||
* @returns {Promise<Array>}
|
||||
@@ -260,3 +267,4 @@ export {
|
||||
getMirrorStatus,
|
||||
ALL_MIRRORS
|
||||
};
|
||||
// ══════════════════════════════════════════════════════════════ END: mirror.helper.js
|
||||
|
||||
Reference in New Issue
Block a user