Interface GitHubContent

Represents a file or directory entry in a GitHub repository.

See

https://docs.github.com/en/rest/repos/contents#get-repository-content

interface GitHubContent {
    _links: Record<string, string>;
    content?: string;
    download_url: null | string;
    encoding?: string;
    html_url: string;
    name: string;
    path: string;
    sha: string;
    size: number;
    type: "file" | "dir" | "symlink" | "submodule";
    url: string;
}

Properties

_links content? download_url encoding? html_url name path sha size type url

Properties

_links

_links: Record<string, string>

HAL links

Optionalcontent

content?: string

Base64-encoded file content. Only present for files when type is 'file'. Decode with Buffer.from(content, 'base64').toString() or atob(content).

download_url

download_url: null | string

URL to the raw file content

Optionalencoding

encoding?: string

Content encoding (only for files — always 'base64')

html_url

html_url: string

URL to this file on GitHub

name

name: string

Entry name (filename or directory name)

path

path: string

Path from repository root

sha

sha: string

Blob SHA

size

size: number

File size in bytes

type

type: "file" | "dir" | "symlink" | "submodule"

Entry type

url

url: string

API URL to this content entry

Settings

Member Visibility

On This Page

Properties