use-github

Index

Interfaces

Functions

Functions

useGitHubPinnedRepos

useGitHubPinnedRepos(username: string): { data: undefined | (GitHubPinnedRepo & { url: string })[]; error?: Error; isValidating: boolean; mutate: KeyedMutator<GitHubPinnedRepo[]> }

- Defined in src/pinned-repos.ts:18
Get the GitHub Pinned Repositories of an user

Parameters
- username: string
  
  The GitHub username to fetch
Returns { data: undefined | (GitHubPinnedRepo & { url: string })[]; error?: Error; isValidating: boolean; mutate: KeyedMutator<GitHubPinnedRepo[]> }
The array of pined repos
- data: undefined | (GitHubPinnedRepo & { url: string })[]
- Optional error?: Error
- isValidating: boolean
- mutate: KeyedMutator<GitHubPinnedRepo[]>

useGitHubUser

useGitHubUser(username: string): SWRResponse<GitHubUser, Error>

- Defined in src/user.ts:46
Get the data of a GitHub User

Parameters
- username: string
  
  The GitHub username to fetch
Returns SWRResponse<GitHubUser, Error>
The GitHub user data

Generated using TypeDoc