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
+54 -1
View File
@@ -1,3 +1,20 @@
/*
* ======= • ======= • ======= • ======= • =======• =======
* AniKatoAPI — azList.extractor.js
* Repository: https://github.com/Shineii86/AniKatoAPI
*
* @description
* Extracts anime from A-Z listing pages with pagination.
* Supports filtering by letter (a-z) or "all" for complete list.
*
* @exports
* extractAzList
*
* @author Shinei Nouzen
* @license MIT
* ======= • ======= • ======= • ======= • =======• =======
*/
import * as cheerio from "cheerio";
import axios from "axios";
import { headers } from "../configs/header.config.js";
@@ -5,13 +22,46 @@ import { URLS } from "../configs/dataUrl.js";
import { extractPages } from "../helper/extractPages.helper.js";
import { countPages } from "../helper/countPages.helper.js";
// ══════════════════════════════════════════════════════════════
// A-Z LIST EXTRACTION
// ══════════════════════════════════════════════════════════════
// ---- FEATURE: Extract anime from A-Z listing with pagination ----
/**
* Fetches and parses anime from the A-Z listing page.
* Supports filtering by letter (a-z) or "all" for complete list.
*
* @param {string} letter - Letter to filter by (a-z) or "all" (default: "all")
* @param {number} page - Page number to fetch (default: 1)
* @returns {Promise<Object>} Object containing totalPages, letter, and data array
* @returns {number} return.totalPages - Total number of pages available
* @returns {string} return.letter - The letter filter used
* @returns {Array<Object>} return.data - Array of anime objects
* @returns {string} return.data[].slug - URL slug for the anime
* @returns {string} return.data[].poster - Poster image URL
* @returns {string} return.data[].title - English title
* @returns {string} return.data[].japaneseTitle - Japanese title
* @returns {number} return.data[].sub - Subbed episode count
* @returns {number} return.data[].dub - Dubbed episode count
* @returns {number} return.data[].total - Total episode count
* @returns {string} return.data[].type - Anime type (TV, Movie, etc.)
* @returns {string} return.data[].rating - Anime rating
*
* @example
* const azList = await extractAzList("a", 1);
* console.log(azList.letter); // "a"
* console.log(azList.data[0].title); // First anime starting with "a"
*/
const extractAzList = async (letter = "all", page = 1) => {
try {
// NOTE: URLS.azList generates the correct endpoint for the given letter
const url = URLS.azList(letter);
const $ = await extractPages(url, page);
const totalPages = countPages($);
const results = [];
// NOTE: Multiple selectors to handle different page layouts
$(".film_list-wrap .flw-item, .film-detail, .item").each((i, el) => {
const slug = $(el).find("a").attr("href")?.split("/watch/").pop() || "";
const poster = $(el).find("img").attr("src") || "";
@@ -23,6 +73,7 @@ const extractAzList = async (letter = "all", page = 1) => {
const type = $(el).find(".meta .inner .right, .fdi-item:nth-child(2)").text().trim() || "";
const rating = $(el).find(".rating, .fdi-item:nth-child(3)").text().trim() || "";
// NOTE: Only include items with valid slugs
if (slug) {
results.push({
slug,
@@ -44,4 +95,6 @@ const extractAzList = async (letter = "all", page = 1) => {
}
};
export { extractAzList };
export { extractAzList };
// ══════════════════════════════════════════════════════════════ END: azList.extractor.js