Home / Function/ getGitHubFileContentsImmutableOnly() — supabase Function Reference

getGitHubFileContentsImmutableOnly() — supabase Function Reference

Architecture documentation for the getGitHubFileContentsImmutableOnly() function in octokit.ts from the supabase codebase.

Function typescript DocumentationSystem ReferenceGen calls 2

Entity Profile

Dependency Diagram

graph TD
  ee8de8b7_e8af_56c2_fb6b_f0ff1d2a3bdd["getGitHubFileContentsImmutableOnly()"]
  65d39265_59d2_2308_2c7d_2d59c9134267["checkForImmutableCommit()"]
  ee8de8b7_e8af_56c2_fb6b_f0ff1d2a3bdd -->|calls| 65d39265_59d2_2308_2c7d_2d59c9134267
  fa70cd46_6219_d8e8_0dc2_82ecdff73892["getGitHubFileContents()"]
  ee8de8b7_e8af_56c2_fb6b_f0ff1d2a3bdd -->|calls| fa70cd46_6219_d8e8_0dc2_82ecdff73892
  style ee8de8b7_e8af_56c2_fb6b_f0ff1d2a3bdd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/lib/octokit.ts lines 88–121

export async function getGitHubFileContentsImmutableOnly({
  org,
  repo,
  branch,
  path,
  options: { onError, fetch },
}: {
  org: string
  repo: string
  branch: string
  path: string
  options: {
    onError: (error: unknown) => void
    fetch: (url: string) => Promise<Response>
  }
}): Promise<string> {
  const isImmutableCommit = await checkForImmutableCommit({
    org,
    repo,
    branch,
  })
  if (!isImmutableCommit) {
    throw Error('The commit is not an immutable commit SHA. Tags and branch names are not allowed.')
  }

  const result = await getGitHubFileContents({
    org,
    repo,
    branch,
    path,
    options: { onError, fetch },
  })
  return result || ''
}

Domain

Subdomains

Calls

Source

Frequently Asked Questions

What does getGitHubFileContentsImmutableOnly() do?
getGitHubFileContentsImmutableOnly() is a function in the supabase codebase.
What does getGitHubFileContentsImmutableOnly() call?
getGitHubFileContentsImmutableOnly() calls 2 function(s): checkForImmutableCommit, getGitHubFileContents.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free