api.ts#
4 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.
4
symbols
4
functions
8
parameters
4
returns
Reference#
fnfetchGitHubSource(source: GitHubSourceRef, options: Required<GitHubOptions>): Promise<GitHubSourceData | null>Fetch source file data from GitHub API.
Fetch source file data from GitHub API.
Signature
export async function fetchGitHubSource(source: GitHubSourceRef, options: Required<GitHubOptions>): Promise<GitHubSourceData | null>Parameters
-
sourceGitHubSourceRef -
optionsRequired<GitHubOptions>
Returns
Promise<GitHubSourceData | null>
fnfetchRepoData(repo: string, options: Required<GitHubOptions>): Promise<GitHubRepoData | null>Fetch repository data from GitHub API.
Fetch repository data from GitHub API.
Signature
export async function fetchRepoData(repo: string, options: Required<GitHubOptions>): Promise<GitHubRepoData | null>Parameters
-
repostring -
optionsRequired<GitHubOptions>
Returns
Promise<GitHubRepoData | null>
fnprefetchGitHubRepos(repos: string[], options?: GitHubOptions): Promise<Map<string, GitHubRepoData | null>>Pre-fetch all GitHub repos data.
Pre-fetch all GitHub repos data.
Signature
export async function prefetchGitHubRepos(repos: string[], options?: GitHubOptions): Promise<Map<string, GitHubRepoData | null>>Parameters
-
reposstring[] -
optionsGitHubOptionsoptional
Returns
Promise<Map<string, GitHubRepoData | null>>
fnprefetchGitHubSources(sources: GitHubSourceRef[], options?: GitHubOptions): Promise<Map<string, GitHubSourceData | null>>Pre-fetch all GitHub source files.
Pre-fetch all GitHub source files.
Signature
export async function prefetchGitHubSources(sources: GitHubSourceRef[], options?: GitHubOptions): Promise<Map<string, GitHubSourceData | null>>Parameters
-
sourcesGitHubSourceRef[] -
optionsGitHubOptionsoptional
Returns
Promise<Map<string, GitHubSourceData | null>>