Refactor: Top langs card: Use typedef tags inside data fetcher (#3061)

This commit is contained in:
Alexandr Garbuzov authored and GitHub committed 2023-08-10 08:41:35 +02:00
1 parent 75d378dfa8
commit c04dd426b1
1 file changed
+14 -3
+14 -3
View File
@@ -8,12 +8,17 @@ import {
wrapTextMultiline, wrapTextMultiline,
} from "../common/utils.js"; } from "../common/utils.js";
/**
* @typedef {import("axios").AxiosRequestHeaders} AxiosRequestHeaders Axios request headers.
* @typedef {import("axios").AxiosResponse} AxiosResponse Axios response.
*/
/** /**
* Top languages fetcher object. * Top languages fetcher object.
* *
* @param {import('axios').AxiosRequestHeaders} variables Fetcher variables. * @param {AxiosRequestHeaders} variables Fetcher variables.
* @param {string} token GitHub token. * @param {string} token GitHub token.
* @returns {Promise<import('../common/types').StatsFetcherResponse>} Languages fetcher response. * @returns {Promise<AxiosResponse>} Languages fetcher response.
*/ */
const fetcher = (variables, token) => { const fetcher = (variables, token) => {
return request( 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. * Fetch top languages for a given username.
* *
* @param {string} username GitHub username. * @param {string} username GitHub username.
* @param {string[]} exclude_repo List of repositories to exclude. * @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 ( const fetchTopLanguages = async (
username, username,