Interface GitHubGist

Represents a GitHub Gist.

interface GitHubGist {
    comments: number;
    comments_url: string;
    commits_url?: string;
    created_at: string;
    description: null | string;
    files: Record<string, GistFile>;
    fork_of?: null | GitHubGist;
    forks_url?: string;
    git_pull_url: string;
    git_push_url: string;
    html_url: string;
    id: string;
    node_id: string;
    owner: null | GitHubUser;
    public: boolean;
    starred?: boolean;
    updated_at: string;
    user: null | GitHubUser;
}

Properties

comments comments_url commits_url? created_at description files fork_of? forks_url? git_pull_url git_push_url html_url id node_id owner public starred? updated_at user

Properties

comments

comments: number

Number of comments

comments_url

comments_url: string

URL to the gist's comments API

Optionalcommits_url

commits_url?: string

Number of commits

created_at

created_at: string

ISO 8601 creation timestamp

description

description: null | string

Short description of the gist

files

files: Record<string, GistFile>

Map of filename to file metadata

Optionalfork_of

fork_of?: null | GitHubGist

Fork metadata, if this is a fork

Optionalforks_url

forks_url?: string

Number of forks

git_pull_url

git_pull_url: string

Git pull URL

git_push_url

git_push_url: string

Git push URL

html_url

html_url: string

GitHub web URL for the gist

id

id: string

Unique gist ID

node_id

node_id: string

Node ID

owner

owner: null | GitHubUser

Owner of the gist

public

public: boolean

Whether the gist is public

Optionalstarred

starred?: boolean

Whether the authenticated user has starred this gist

updated_at

updated_at: string

ISO 8601 last-update timestamp

user

user: null | GitHubUser

User who forked this gist, if applicable

Settings

Member Visibility

On This Page

Properties