Refactor: Top langs card: Use typedef tags inside data fetcher (anura…

…ghazra#3061)
phamleduy04 · Aug 10, 2023 · c04dd42 · c04dd42
1 parent 75d378d
commit c04dd42
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/src/fetchers/top-languages-fetcher.js b/src/fetchers/top-languages-fetcher.js
@@ -8,12 +8,17 @@ import {
   wrapTextMultiline,
 } from "../common/utils.js";
 
+/**
+ * @typedef {import("axios").AxiosRequestHeaders} AxiosRequestHeaders Axios request headers.
+ * @typedef {import("axios").AxiosResponse} AxiosResponse Axios response.
+ */
+
 /**
  * Top languages fetcher object.
  *
- * @param {import('axios').AxiosRequestHeaders} variables Fetcher variables.
+ * @param {AxiosRequestHeaders} variables Fetcher variables.
  * @param {string} token GitHub token.
- * @returns {Promise<import('../common/types').StatsFetcherResponse>} Languages fetcher response.
+ * @returns {Promise<AxiosResponse>} Languages fetcher response.
  */
 const fetcher = (variables, token) => {
   return request(
@@ -47,12 +52,18 @@ const fetcher = (variables, token) => {
   );
 };
 
+/**
+ * @typedef {import("./types").TopLangData} TopLangData Top languages data.
+ */
+
 /**
  * Fetch top languages for a given username.
  *
  * @param {string} username GitHub username.
  * @param {string[]} exclude_repo List of repositories to exclude.
- * @returns {Promise<import("./types").TopLangData>} Top languages data.
+ * @param {number} size_weight Weightage to be given to size.
+ * @param {number} count_weight Weightage to be given to count.
+ * @returns {Promise<TopLangData>} Top languages data.
  */
 const fetchTopLanguages = async (
   username,