Interface GitHubRepository

Represents a GitHub repository.

See

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

interface GitHubRepository {
    archived: boolean;
    clone_url: string;
    created_at: string;
    default_branch: string;
    description: null | string;
    disabled: boolean;
    fork: boolean;
    forks_count: number;
    full_name: string;
    has_discussions?: boolean;
    has_issues?: boolean;
    has_projects?: boolean;
    has_wiki?: boolean;
    html_url: string;
    id: number;
    language: null | string;
    name: string;
    open_issues_count: number;
    owner: GitHubUser;
    parent?: GitHubRepository;
    private: boolean;
    pushed_at: null | string;
    size?: number;
    ssh_url: string;
    stargazers_count: number;
    topics: string[];
    updated_at: string;
    visibility: "public" | "private" | "internal";
    watchers_count: number;
}

Properties

archived clone_url created_at default_branch description disabled fork forks_count full_name has_discussions? has_issues? has_projects? has_wiki? html_url id language name open_issues_count owner parent? private pushed_at size? ssh_url stargazers_count topics updated_at visibility watchers_count

Properties

archived

archived: boolean

Whether the repository is archived

clone_url

clone_url: string

HTTPS clone URL

created_at

created_at: string

ISO 8601 timestamp of repository creation

default_branch

default_branch: string

Default branch name (e.g., 'main')

description

description: null | string

Repository description

disabled

disabled: boolean

Whether the repository is disabled

fork

fork: boolean

Whether the repository is a fork

forks_count

forks_count: number

Number of forks

full_name

full_name: string

Full name including owner (e.g., 'octocat/Hello-World')

Optionalhas_discussions

has_discussions?: boolean

Whether the repository has discussions enabled

Optionalhas_issues

has_issues?: boolean

Whether the repository has issues enabled

Optionalhas_projects

has_projects?: boolean

Whether the repository has projects enabled

Optionalhas_wiki

has_wiki?: boolean

Whether the repository has wiki enabled

html_url

html_url: string

URL to the repository on GitHub

id

id: number

Unique numeric repository ID

language

language: null | string

Primary language

name

name: string

Repository name (e.g., 'Hello-World')

open_issues_count

open_issues_count: number

Number of open issues and pull requests

owner

owner: GitHubUser

Repository owner (user or organization)

Optionalparent

parent?: GitHubRepository

Parent repository, if this is a fork

private

private: boolean

Whether the repository is private

pushed_at

pushed_at: null | string

ISO 8601 timestamp of the last push

Optionalsize

size?: number

Repository size in kilobytes

ssh_url

ssh_url: string

SSH clone URL

stargazers_count

stargazers_count: number

Number of stargazers

topics

topics: string[]

Repository topics

updated_at

updated_at: string

ISO 8601 timestamp of last update

visibility

visibility: "public" | "private" | "internal"

Repository visibility

watchers_count

watchers_count: number

Number of watchers

Settings

Member Visibility

On This Page

Properties