diff options
Diffstat (limited to 'src/utils/hooks/use-github-api.tsx')
| -rw-r--r-- | src/utils/hooks/use-github-api.tsx | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/utils/hooks/use-github-api.tsx b/src/utils/hooks/use-github-api.tsx new file mode 100644 index 0000000..edff974 --- /dev/null +++ b/src/utils/hooks/use-github-api.tsx @@ -0,0 +1,30 @@ +import { SWRResult } from '@ts/types/swr'; +import useSWR, { Fetcher } from 'swr'; + +export type RepoData = { + created_at: string; + updated_at: string; + stargazers_count: number; +}; + +const fetcher: Fetcher<RepoData, string> = (...args) => + fetch(...args).then((res) => res.json()); + +/** + * Retrieve data from Github API. + * + * @param repo - The Github repo (`owner/repo-name`). + * @returns The repository data. + */ +const useGithubApi = (repo: string): SWRResult<RepoData> => { + const apiUrl = repo ? `https://api.github.com/repos/${repo}` : null; + const { data, error } = useSWR<RepoData>(apiUrl, fetcher); + + return { + data, + isLoading: !error && !data, + isError: error, + }; +}; + +export default useGithubApi; |
