Skip to content

Add jsdocs to api methods #9

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
sarah-codatest wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add jsdocs to api methods #9

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
6 changes: 6 additions & 0 deletions app/utils/github-api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,17 @@ const BASE_URL = 'https://api.github.com';

export {getRepos, getUserData};

/**
* This function gets the repositories for the given username.
*/
function getRepos(username) {
const url = `${BASE_URL}/users/${username}/repos?per_page=250`;
return axios.get(url).then(response => response.data);
}

/**
* This function gets account data associated with the given username.
*/
function getUserData(username) {
return axios.all([
axios.get(`${BASE_URL}/users/${username}`),
Expand Down