anilink-api-wrapper 1.17.4 → 1.17.6

package/dist/apis/anilist/query/page/Reviews.js

@@ -13,11 +13,26 @@ exports.ReviewsQuery = void 0;
 const APIWrapper_1 = require("../../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../../base/RequestHandler");
 const Review_1 = require("../../interfaces/responses/query/Review");
+/**
+ * `ReviewsQuery` is a class representing a query for reviews.
+ * It includes a method to get reviews.
+ */
 class ReviewsQuery extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `ReviewsQuery` instance.
+     *
+     * @param authToken - The authentication token.
+     */
     constructor(authToken) {
         super('https://graphql.anilist.co');
         this.authToken = authToken;
     }
+    /**
+     * `reviews` is a method that sends a query request to get reviews.
+     *
+     * @param variables - The variables for the query.
+     * @returns The response from the query request.
+     */
     reviews(variables) {
         return __awaiter(this, void 0, void 0, function* () {
             const query = `

package/dist/apis/anilist/query/page/Staffs.js

@@ -13,11 +13,26 @@ exports.StaffsQuery = void 0;
 const APIWrapper_1 = require("../../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../../base/RequestHandler");
 const Staff_1 = require("../../interfaces/responses/query/Staff");
+/**
+ * `StaffsQuery` is a class representing a query for staffs.
+ * It includes a method to get staffs.
+ */
 class StaffsQuery extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `StaffsQuery` instance.
+     *
+     * @param authToken - The authentication token.
+     */
     constructor(authToken) {
         super('https://graphql.anilist.co');
         this.authToken = authToken;
     }
+    /**
+     * `staffs` is a method that sends a query request to get staffs.
+     *
+     * @param variables - The variables for the query.
+     * @returns The response from the query request.
+     */
     staffs(variables) {
         return __awaiter(this, void 0, void 0, function* () {
             const query = `

package/dist/apis/anilist/query/page/Studios.js

@@ -13,11 +13,26 @@ exports.StudiosQuery = void 0;
 const APIWrapper_1 = require("../../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../../base/RequestHandler");
 const Studio_1 = require("../../interfaces/responses/query/Studio");
+/**
+ * `StudiosQuery` is a class representing a query for studios.
+ * It includes a method to get studios.
+ */
 class StudiosQuery extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `StudiosQuery` instance.
+     *
+     * @param authToken - The authentication token.
+     */
     constructor(authToken) {
         super('https://graphql.anilist.co');
         this.authToken = authToken;
     }
+    /**
+     * `studios` is a method that sends a query request to get studios.
+     *
+     * @param variables - The variables for the query.
+     * @returns The response from the query request.
+     */
     studios(variables) {
         return __awaiter(this, void 0, void 0, function* () {
             const query = `

package/dist/apis/anilist/query/page/ThreadCommments.js

@@ -13,11 +13,26 @@ exports.ThreadCommentsQuery = void 0;
 const APIWrapper_1 = require("../../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../../base/RequestHandler");
 const ThreadComment_1 = require("../../interfaces/responses/query/ThreadComment");
+/**
+ * `ThreadCommentsQuery` is a class representing a query for thread comments.
+ * It includes a method to get thread comments.
+ */
 class ThreadCommentsQuery extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `ThreadCommentsQuery` instance.
+     *
+     * @param authToken - The authentication token.
+     */
     constructor(authToken) {
         super('https://graphql.anilist.co');
         this.authToken = authToken;
     }
+    /**
+     * `threadComments` is a method that sends a query request to get thread comments.
+     *
+     * @param variables - The variables for the query.
+     * @returns The response from the query request.
+     */
     threadComments(variables) {
         return __awaiter(this, void 0, void 0, function* () {
             const query = `

package/dist/apis/anilist/query/page/Threads.js

@@ -13,11 +13,26 @@ exports.ThreadsQuery = void 0;
 const APIWrapper_1 = require("../../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../../base/RequestHandler");
 const Thread_1 = require("../../interfaces/responses/query/Thread");
+/**
+ * `ThreadsQuery` is a class representing a query for threads.
+ * It includes a method to get threads.
+ */
 class ThreadsQuery extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `ThreadsQuery` instance.
+     *
+     * @param authToken - The authentication token.
+     */
     constructor(authToken) {
         super('https://graphql.anilist.co');
         this.authToken = authToken;
     }
+    /**
+     * `threads` is a method that sends a query request to get threads.
+     *
+     * @param variables - The variables for the query.
+     * @returns The response from the query request.
+     */
     threads(variables) {
         return __awaiter(this, void 0, void 0, function* () {
             const query = `

package/dist/apis/anilist/query/page/Users.js

@@ -13,11 +13,26 @@ exports.UsersQuery = void 0;
 const APIWrapper_1 = require("../../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../../base/RequestHandler");
 const User_1 = require("../../interfaces/responses/query/User");
+/**
+ * `UsersQuery` is a class representing a query for users.
+ * It includes a method to get users.
+ */
 class UsersQuery extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `UsersQuery` instance.
+     *
+     * @param authToken - The authentication token.
+     */
     constructor(authToken) {
         super('https://graphql.anilist.co');
         this.authToken = authToken;
     }
+    /**
+     * `users` is a method that sends a query request to get users.
+     *
+     * @param variables - The variables for the query.
+     * @returns The response from the query request.
+     */
     users(variables) {
         return __awaiter(this, void 0, void 0, function* () {
             const query = `

package/dist/base/APIWrapper.js

@@ -1,7 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APIWrapper = void 0;
+/**
+ * `APIWrapper` is a base class for API wrappers.
+ * It provides a basic structure that can be extended by specific API wrappers.
+ */
 class APIWrapper {
+    /**
+     * Constructs a new `APIWrapper` instance.
+     * @param baseURL - The base URL for the API.
+     */
     constructor(baseURL) {
         this.baseURL = baseURL;
     }

package/dist/base/RequestHandler.js

@@ -14,6 +14,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sendRequest = void 0;
 const axios_1 = __importDefault(require("axios"));
+/**
+ * Sends a request to the specified URL.
+ * @param url - The URL to send the request to.
+ * @param method - The HTTP method to use ('GET' or 'POST').
+ * @param data - The data to send with the request.
+ * @param token - The authentication token to include in the request headers.
+ * @returns The data from the response.
+ * @throws An error if the request fails.
+ */
 const sendRequest = (url, method, data, token) => __awaiter(void 0, void 0, void 0, function* () {
     const headers = {
         'Content-Type': 'application/json',

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "anilink-api-wrapper",
-  "version": "1.17.4",
+  "version": "1.17.6",
   "description": "Anilist API Wrapper",
   "main": "dist/AniLink.js",
   "scripts": {
     "test": "jest",
     "build": "tsc",
+    "generate-docs": "typedoc --entryPoints ./src --entryPointStrategy expand --out docs --plugin typedoc-theme-hierarchy --theme hierarchy",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -24,6 +25,8 @@
     "standard": "^17.1.0",
     "ts-jest": "^29.1.2",
     "ts-standard": "^12.0.2",
+    "typedoc": "^0.25.13",
+    "typedoc-theme-hierarchy": "^4.1.2",
     "typescript": "^5.4.5"
   },
   "dependencies": {

package/typedoc.json

@@ -0,0 +1,15 @@
+{
+  "out": "./docs",
+  "entryPoints": ["./src"],
+  "entryPointStrategy": "expand",
+  "exclude": ["**/__tests__/**"],
+  "name": "AniLink",
+  "readme": "README.md",
+  "plugin": ["typedoc-theme-hierarchy"],
+  "theme": "hierarchy",
+  "tsconfig": "./tsconfig.json",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeExternals": true,
+  "includeVersion": true
+}