Skip to content

docs: Add JSDoc documentation to CountLanguages class #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nayab-Gauhar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add JSDoc documentation to CountLanguages class #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions countLanguages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
/**
* A utility class for analyzing programming language usage across GitHub repositories.
*/
class CountLanguages {
/**
* Counts the number of repositories that use each programming language.
*
* @param {Array<Object>} repositories - An array of repository objects with a 'language' property
* @returns {Object} An object mapping language names to their usage count
* @example
* // Returns { JavaScript: 3, Python: 2 }
* countLanguageUsage([
* { language: 'JavaScript' },
* { language: 'JavaScript' },
* { language: 'Python' },
* { language: 'JavaScript' },
* { language: 'Python' }
* ]);
*/
countLanguageUsage(repositories) {
const languageCount = {};

for (const repo of repositories) {
const language = repo.language;

if (language) {
if (languageCount[language]) {
languageCount[language]++;
Expand All @@ -13,9 +29,7 @@ class CountLanguages {
}
}
}

return languageCount;
}
}

module.exports = CountLanguages;