Skip to main content

​
Constants

​
GitHubReasons

A set of constants representing possible reasons for a GitHub event.
Explanations for each reason can be found in the GitHub Docs. 
export const GitHubReasons: {
    Assign: 'assign';
    Author: 'author';
    Comment: 'comment';
    Invitation: 'invitation';
    Manual: 'manual';
    Mention: 'mention';
    ReviewRequested: 'review_requested';
    SecurityAlert: 'security_alert';
    StateChange: 'state_change';
    Subscribed: 'subscribed';
    TeamMention: 'team_mention';
    CiActivity: 'ci_activity';
};

​
GitHubTypes

A set of constants representing possible types of GitHub events. 
export const GitHubTypes: {
    CheckSuite: 'CheckSuite';
    Commit: 'Commit';
    Discussion: 'Discussion';
    Issue: 'Issue';
    PullRequest: 'PullRequest';
    Release: 'Release';
    RepositoryVulnerabilityAlert: 'RepositoryVulnerabilityAlert';
};

​
Types

​
GitHubEvent

Represents a GitHub event. 
interface GitHubEvent {
    title: string;
    url: string;
    reason: string;
    type: string;
    repository: GitHubRepository;
}

​
GitHubRepository

Represents a GitHub repository. 
interface GitHubRepository {
    fullName: string;
    name: string;
    url: string;
    private: boolean;
    description: string;
    fork: boolean;
    owner: GitHubOwner;
}

​
GitHubOwner

Represents the owner of a GitHub repository. 
interface GitHubOwner {
    login: string;
    url: string;
    type: string;
    siteAdmin: boolean;
}
⌘I