Class RepositoryResource

Represents a GitHub repository resource with chainable async methods.

Implements PromiseLike<GitHubRepository> so it can be awaited directly to fetch repository info, while also exposing sub-resource methods.

Example

// Await directly to get repository info
const repo = await gh.org('github').repo('linguist');

// Get pull requests
const prs = await gh.org('github').repo('linguist').pullRequests({ state: 'open' });

// Navigate into a specific pull request
const files = await gh.org('github').repo('linguist').pullRequest(42).files();

// Get commits
const commits = await gh.org('github').repo('linguist').commits({ per_page: 10 });

// Get raw file content
const content = await gh.org('github').repo('linguist').raw('README.md');

Implements

PromiseLike<GitHubRepository>

Methods

branch

branch(name: string): Promise<GitHubBranch>
Fetches a specific branch by name.

GET /repos/{owner}/{repo}/branches/{branch}
Parameters
- name: string
  The branch name (e.g., 'main')
Returns Promise<GitHubBranch>
The branch object
- Defined in src/resources/RepositoryResource.ts:168

branches

branches(params?: BranchesParams): Promise<GitHubPagedResponse<GitHubBranch>>
Fetches branches for this repository.

GET /repos/{owner}/{repo}/branches
Parameters
- Optionalparams: BranchesParams
  Optional filters: protected, per_page, page
Returns Promise<GitHubPagedResponse<GitHubBranch>>
A paged response of branches
- Defined in src/resources/RepositoryResource.ts:153

commit

commit(ref: string): CommitResource
Returns a CommitResource for a given commit ref (SHA, branch, or tag).
Parameters
- ref: string
  Commit SHA, branch name, or tag name
Returns CommitResource
A chainable commit resource
- Defined in src/resources/RepositoryResource.ts:135

commits

commits(params?: CommitsParams): Promise<GitHubPagedResponse<GitHubCommit>>
Fetches commits for this repository.

GET /repos/{owner}/{repo}/commits
Parameters
- Optionalparams: CommitsParams
  Optional filters: sha, path, author, since, until, per_page, page
Returns Promise<GitHubPagedResponse<GitHubCommit>>
A paged response of commits
- Defined in src/resources/RepositoryResource.ts:122

contents(
path?: string,
params?: ContentParams,
): Promise<GitHubContent | GitHubContent[]>
Fetches the contents of a file or directory in this repository.

GET /repos/{owner}/{repo}/contents/{path}

Returns a single GitHubContent for files, or an array for directories.
Parameters
- Optionalpath: string
  Path to the file or directory. Omit for root.
- Optionalparams: ContentParams
  Optional: ref (branch, tag, or commit SHA)
Returns Promise<GitHubContent | GitHubContent[]>
- Defined in src/resources/RepositoryResource.ts:337

contributors

contributors(
    params?: PaginationParams & { anon?: boolean },
): Promise<
    GitHubPagedResponse<
        {
            avatar_url?: string;
            contributions: number;
            html_url?: string;
            id?: number;
            login?: string;
        },
    >,
>
Fetches contributors to this repository.

GET /repos/{owner}/{repo}/contributors
Parameters
- Optionalparams: PaginationParams & { anon?: boolean }
  Optional filters: anon, per_page, page
Returns Promise<
    GitHubPagedResponse<
        {
            avatar_url?: string;
            contributions: number;
            html_url?: string;
            id?: number;
            login?: string;
        },
    >,
>
- Defined in src/resources/RepositoryResource.ts:382

createFork

createFork(data?: CreateForkData): Promise<GitHubRepository>
Creates a fork of this repository.

POST /repos/{owner}/{repo}/forks

Note: Forking is asynchronous on GitHub's side. The returned repository may not be fully ready immediately after this call returns.
Parameters
- Optionaldata: CreateForkData
  Optional: target organization, custom name, default-branch-only flag
Returns Promise<GitHubRepository>
The newly created fork
Example
```
// Fork into authenticated user's account
const fork = await gh.repo('octocat', 'Hello-World').createFork();

// Fork into an organization with a custom name
const fork = await gh.repo('octocat', 'Hello-World').createFork({
  organization: 'my-org',
  name: 'hello-world-fork',
});
```
- Defined in src/resources/RepositoryResource.ts:251

createIssue

createIssue(data: CreateIssueData): Promise<GitHubIssue>
Creates an issue in this repository.

POST /repos/{owner}/{repo}/issues
Parameters
- data: CreateIssueData
  Issue data. title is required.
Returns Promise<GitHubIssue>
The created issue
Example
```
const issue = await gh.repo('octocat', 'Hello-World').createIssue({
  title: 'Found a bug',
  body: 'Steps to reproduce...',
  labels: ['bug'],
});
```
- Defined in src/resources/RepositoryResource.ts:449

createWebhook

createWebhook(data: CreateWebhookData): Promise<GitHubWebhook>
Creates a webhook on this repository.

POST /repos/{owner}/{repo}/hooks
Parameters
- data: CreateWebhookData
  Webhook configuration. config.url is required.
Returns Promise<GitHubWebhook>
The created webhook
Example
```
const hook = await gh.repo('octocat', 'Hello-World').createWebhook({
  config: { url: 'https://example.com/webhook', content_type: 'json', secret: 'mysecret' },
  events: ['push', 'pull_request'],
});
```
- Defined in src/resources/RepositoryResource.ts:286

deleteWebhook

deleteWebhook(hookId: number): Promise<void>
Deletes a webhook from this repository.

DELETE /repos/{owner}/{repo}/hooks/{hook_id}
Parameters
- hookId: number
  The webhook ID to delete
Returns Promise<void>
Example
```
await gh.repo('octocat', 'Hello-World').deleteWebhook(1);
```
- Defined in src/resources/RepositoryResource.ts:323

forks

forks(params?: ForksParams): Promise<GitHubPagedResponse<GitHubRepository>>
Fetches the forks of this repository.

GET /repos/{owner}/{repo}/forks
Parameters
- Optionalparams: ForksParams
  Optional filters: sort, per_page, page
Returns Promise<GitHubPagedResponse<GitHubRepository>>
A paged response of forked repositories
- Defined in src/resources/RepositoryResource.ts:221

get

get(): Promise<GitHubRepository>
Fetches the repository details.

GET /repos/{owner}/{repo}

Returns Promise<GitHubRepository>
The repository object
- Defined in src/resources/RepositoryResource.ts:79

issue

issue(issueNumber: number): IssueResource
Returns an IssueResource for a given issue number.

The returned resource can be awaited directly to fetch issue info, or chained to access sub-resources (comments).
Parameters
- issueNumber: number
  The issue number within the repository
Returns IssueResource
A chainable issue resource
Example
```
const issue    = await gh.repo('octocat', 'Hello-World').issue(1);
const comments = await gh.repo('octocat', 'Hello-World').issue(1).comments();
```
- Defined in src/resources/RepositoryResource.ts:422

issues

issues(params?: IssuesParams): Promise<GitHubPagedResponse<GitHubIssue>>
Fetches issues for this repository.

GET /repos/{owner}/{repo}/issues

Note: GitHub returns pull requests as issues in this endpoint. Filter them out by checking for the absence of pull_request.
Parameters
- Optionalparams: IssuesParams
  Optional filters: state, labels, sort, direction, since, per_page, page
Returns Promise<GitHubPagedResponse<GitHubIssue>>
A paged response of issues
- Defined in src/resources/RepositoryResource.ts:400

latestRelease

latestRelease(): Promise<GitHubRelease>
Fetches the latest published release for this repository.

GET /repos/{owner}/{repo}/releases/latest

Returns Promise<GitHubRelease>
The latest release object
- Defined in src/resources/RepositoryResource.ts:209

pullRequest

pullRequest(pullNumber: number): PullRequestResource
Returns a PullRequestResource for a given pull request number.
Parameters
- pullNumber: number
  The pull request number (not the ID)
Returns PullRequestResource
A chainable pull request resource
- Defined in src/resources/RepositoryResource.ts:104

pullRequests

pullRequests(
params?: PullRequestsParams,
): Promise<GitHubPagedResponse<GitHubPullRequest>>
Fetches pull requests for this repository.

GET /repos/{owner}/{repo}/pulls
Parameters
- Optionalparams: PullRequestsParams
  Optional filters: state, head, base, sort, direction, per_page, page
Returns Promise<GitHubPagedResponse<GitHubPullRequest>>
A paged response of pull requests
- Defined in src/resources/RepositoryResource.ts:91

raw

raw(filePath: string, params?: ContentParams): Promise<string>
Fetches the raw text content of a file in this repository.

Uses Accept: application/vnd.github.raw+json.

GET /repos/{owner}/{repo}/contents/{filePath}
Parameters
- filePath: string
  Path to the file (e.g., 'src/index.ts')
- Optionalparams: ContentParams
  Optional: ref (branch, tag, or commit SHA)
Returns Promise<string>
The raw file content as a string
- Defined in src/resources/RepositoryResource.ts:356

releases

releases(params?: ReleasesParams): Promise<GitHubPagedResponse<GitHubRelease>>
Fetches releases for this repository.

GET /repos/{owner}/{repo}/releases
Parameters
- Optionalparams: ReleasesParams
  Optional pagination: per_page, page
Returns Promise<GitHubPagedResponse<GitHubRelease>>
A paged response of releases
- Defined in src/resources/RepositoryResource.ts:195

then

then<TResult1 = GitHubRepository, TResult2 = never>(
    onfulfilled?:
        | null
        | (value: GitHubRepository) => TResult1 | PromiseLike<TResult1>,
    onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): PromiseLike<TResult1 | TResult2>
Allows the resource to be awaited directly, resolving with the repository info. Delegates to RepositoryResource.get.
Type Parameters
- TResult1 = GitHubRepository
- TResult2 = never
Parameters
- Optionalonfulfilled: null | (value: GitHubRepository) => TResult1 | PromiseLike<TResult1>
- Optionalonrejected: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/RepositoryResource.ts:65

topics

topics(): Promise<string[]>
Fetches the repository topics.

GET /repos/{owner}/{repo}/topics

Returns Promise<string[]>
An array of topic strings
- Defined in src/resources/RepositoryResource.ts:370

updateWebhook

updateWebhook(hookId: number, data: UpdateWebhookData): Promise<GitHubWebhook>
Updates an existing webhook on this repository.

PATCH /repos/{owner}/{repo}/hooks/{hook_id}
Parameters
- hookId: number
  The webhook ID
- data: UpdateWebhookData
  Fields to update
Returns Promise<GitHubWebhook>
The updated webhook
Example
```
const hook = await gh.repo('octocat', 'Hello-World').updateWebhook(1, {
  active: false,
  add_events: ['issues'],
});
```
- Defined in src/resources/RepositoryResource.ts:307

webhooks

webhooks(params?: WebhooksParams): Promise<GitHubPagedResponse<GitHubWebhook>>
Fetches webhooks configured on this repository.

GET /repos/{owner}/{repo}/hooks
Parameters
- Optionalparams: WebhooksParams
  Optional pagination: per_page, page
Returns Promise<GitHubPagedResponse<GitHubWebhook>>
A paged response of webhooks
- Defined in src/resources/RepositoryResource.ts:263

Class RepositoryResource

Example

Implements

Index

Methods

Methods

branch

Parameters

Returns Promise<GitHubBranch>

branches

Parameters

Returns Promise<GitHubPagedResponse<GitHubBranch>>

commit

Parameters

Returns CommitResource

commits

Parameters

Returns Promise<GitHubPagedResponse<GitHubCommit>>

contents

Parameters

Returns Promise<GitHubContent | GitHubContent[]>

contributors

Parameters

Returns Promise< GitHubPagedResponse< { avatar_url?: string; contributions: number; html_url?: string; id?: number; login?: string; }, >,>

createFork

Parameters

Returns Promise<GitHubRepository>

Example

createIssue

Parameters

Returns Promise<GitHubIssue>

Example

createWebhook

Parameters

Returns Promise<GitHubWebhook>

Example

deleteWebhook

Parameters

Returns Promise<void>

Example

forks

Parameters

Returns Promise<GitHubPagedResponse<GitHubRepository>>

get

Returns Promise<GitHubRepository>

issue

Parameters

Returns IssueResource

Example

issues

Parameters

Returns Promise<GitHubPagedResponse<GitHubIssue>>

latestRelease

Returns Promise<GitHubRelease>

pullRequest

Parameters

Returns PullRequestResource

pullRequests

Parameters

Returns Promise<GitHubPagedResponse<GitHubPullRequest>>

raw

Parameters

Returns Promise<string>

releases

Parameters

Returns Promise<GitHubPagedResponse<GitHubRelease>>

tags

Parameters

Returns Promise<GitHubPagedResponse<GitHubTag>>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

topics

Returns Promise<string[]>

updateWebhook

Parameters

Returns Promise<GitHubWebhook>

Example

webhooks

Returns Promise<
GitHubPagedResponse<
{
avatar_url?: string;
contributions: number;
html_url?: string;
id?: number;
login?: string;
},
>,
>