UNPKG

aniki

Version:

Aniki is an easy-to-use NPM module that gets information about your favorite anime and manga.

95 lines (70 loc) 3.98 kB
<div align="center"> <h1>Aniki</h1> <h2>Change Logs</h2> In this file, you can see everything got changed. </div> ## Bugs? If you get any bugs, please make an [Issue](https://github.com/Normioffi/Aniki/issues) here! # 1.3.5 1. Fixed an error while installing the package with PNPM. 2. Modified some params description. 3. Modified/added some results description. 4. Edited module description. 5. Added and edited methods in AnimeKitsu and MangaKitsu: - Added #episodes and #chapters - Edited #episode and #chapter 6. Added enums informations. 7. Added missing categories in IKitsuAnimeFind, IKitsuAnimeList, IKitsuMangaFind and IKitsuMangaList and moved them in a new type. (can be imported!) 8. Fixed categories name with \_ (now using -) 9. Fixed some import/export interfaces. 10. Classes, enums will now be exported as normal and not by default, it means that you should change from `const aniki = require("aniki");` to `const { AnimeKitsu, MangaKitsu, EKitsuSeason } = require("aniki");`. 11. Fixed duplicated `TKitsuHandleError, IKitsuError` type and interface. 12. Removed `R18` in EKitsuAgeRating and in find/list params interfaces. (Because it returns nothing.) 13. Fixed max size of `perPage` (30 to 20). + added verification. (return undefined + moduleError if greater than 20.) # 1.3.4 1. Fixed offset/perPage isNaN errors! # 1.3.1 1. Fixed createdAt and updatedAt types! (`string` to `Date`) 2. Fixed AnimeKitsu#findById(id) description that showed a way to use the method with a string with an number inside (like "456") without the ability to do so, now should work properly with `"${number}"` and `number`. 3. Fixed some import/export classes and interfaces? 4. Modified some interfaces informations 5. Fixed `year` parameters that used normal dates (such as "1907", etc...) instead of `number` | `${number}` | `${number}..` | `${number}..${number}`. 6. Fixed some `number` only types on parameters, now able to use `number` or `"${number}"`. (Checking if value is number isn't required, the method will do so by itself.) 7. Changed `@property` to `@param` for the parameters of methods. 8. Fixed a mistake on the module description (added "[...] also for anime waifus." by error.) <small>(Well it was a future possible API to add for waifus, but due to the type of content... It will not.)</small>) 9. Added better descriptions for some parameters. # 1.3.0 1. Full support for **CJS**/**ESM** and **TS**. 2. Created new following methods in: - AnimeKitsu: findById(id), episode(id) - MangaKitsu: findById(id), chapter(id) 3. Created new interfaces for individuals methods parameters and **Promise** response! (Some properties may not have any description, i'll add them later!). 4. There is a new way to handle errors, from now on, methods will have a new parameter named _handleError_, by using this parameter as a asynchronous function, you can now get errors with the corresponding type! Here is an example: ```js anime .find({ query: "Oshi no ko" }, async ({ apiError, moduleError }, status) => { if (apiError) console.error(await apiError); if (moduleError) console.error(await moduleError); }) .then((r) => console.log(r)); ``` It's not required but useful if you want to handle errors by yourself, if you're not using it at all, it will console unhandled errors. 5. For TS users, i made some enums table for seasons, categories, AgeRating (anime only), subtypes Example: ```ts import aniki from "aniki"; import { EKitsuSeason } from "aniki/kitsu/enums"; const anime = new aniki.AnimeKitsu(); anime .find({ query: "Oshi no ko", season: EKitsuSeason.Fall }) // EKitsuSeason.Fall = "fall"; .then((r) => console.log(r.data)); // ... ``` <b>Available enums</b> - EKitsuAnimeAgeRating, - EKitsuAnimeCategories, - EKitsuAnimeStreamers, - EKitsuAnimeSubTypes, - EKitsuMangaCategories, - EKitsuMangaSubTypes, - EKitsuSeason,