mirror of
https://github.com/System-End/github-readme-stats.git
synced 2026-04-19 19:55:16 +00:00
Fixed docstring for trimTopLanguages function (#2833)
* Fixed docstring for trimTopLanguages function * dev
This commit is contained in:
parent
4db78d7796
commit
99aca1b6d5
2 changed files with 8 additions and 10 deletions
|
|
@ -163,11 +163,11 @@ const donutCenterTranslation = (totalLangs) => {
|
|||
* Trim top languages to lang_count while also hiding certain languages.
|
||||
*
|
||||
* @param {Record<string, Lang>} topLangs Top languages.
|
||||
* @param {string[]} hide Languages to hide.
|
||||
* @param {string} langs_count Number of languages to show.
|
||||
* @returns {{topLangs: Record<string, Lang>, totalSize: number}} Trimmed top languages and total size.
|
||||
* @param {string[]=} hide Languages to hide.
|
||||
* @returns {{ langs: Lang[], totalLanguageSize: number }} Trimmed top languages and total size.
|
||||
*/
|
||||
const trimTopLanguages = (topLangs, hide, langs_count) => {
|
||||
const trimTopLanguages = (topLangs, langs_count, hide) => {
|
||||
let langs = Object.values(topLangs);
|
||||
let langsToHide = {};
|
||||
let langsCount = clampValue(parseInt(langs_count), 1, 10);
|
||||
|
|
@ -733,8 +733,8 @@ const renderTopLanguages = (topLangs, options = {}) => {
|
|||
|
||||
const { langs, totalLanguageSize } = trimTopLanguages(
|
||||
topLangs,
|
||||
hide,
|
||||
String(langs_count),
|
||||
hide,
|
||||
);
|
||||
|
||||
let width = isNaN(card_width)
|
||||
|
|
|
|||
|
|
@ -310,21 +310,19 @@ describe("Test renderTopLanguages helper functions", () => {
|
|||
langs: [langs.javascript],
|
||||
totalLanguageSize: 200,
|
||||
});
|
||||
expect(
|
||||
trimTopLanguages([langs.javascript, langs.HTML], [], 5),
|
||||
).toStrictEqual({
|
||||
expect(trimTopLanguages([langs.javascript, langs.HTML], 5)).toStrictEqual({
|
||||
langs: [langs.javascript, langs.HTML],
|
||||
totalLanguageSize: 400,
|
||||
});
|
||||
expect(trimTopLanguages(langs, [], 5)).toStrictEqual({
|
||||
expect(trimTopLanguages(langs, 5)).toStrictEqual({
|
||||
langs: Object.values(langs),
|
||||
totalLanguageSize: 500,
|
||||
});
|
||||
expect(trimTopLanguages(langs, [], 2)).toStrictEqual({
|
||||
expect(trimTopLanguages(langs, 2)).toStrictEqual({
|
||||
langs: Object.values(langs).slice(0, 2),
|
||||
totalLanguageSize: 400,
|
||||
});
|
||||
expect(trimTopLanguages(langs, ["javascript"], 5)).toStrictEqual({
|
||||
expect(trimTopLanguages(langs, 5, ["javascript"])).toStrictEqual({
|
||||
langs: [langs.HTML, langs.css],
|
||||
totalLanguageSize: 300,
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue