Class IssueResource

Represents a GitHub issue resource with chainable async methods.

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

Example

// Await directly to get issue info
const issue = await gh.repo('octocat', 'Hello-World').issue(1);

// Get comments on an issue
const comments = await gh.repo('octocat', 'Hello-World').issue(1).comments();

Implements

PromiseLike<GitHubIssue>

Index

Methods

comments get then

Methods

comments

comments(
params?: PaginationParams & { since?: string },
): Promise<GitHubPagedResponse<GitHubIssueComment>>
Fetches the comments on this issue.

GET /repos/{owner}/{repo}/issues/{issue_number}/comments
Parameters
- Optionalparams: PaginationParams & { since?: string }
  Optional filters: since, per_page, page
Returns Promise<GitHubPagedResponse<GitHubIssueComment>>
A paged response of comments
- Defined in src/resources/IssueResource.ts:64

get

get(): Promise<GitHubIssue>
Fetches the issue details.

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

Returns Promise<GitHubIssue>
The issue object
- Defined in src/resources/IssueResource.ts:52

then

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

Class IssueResource

Example

Implements

Index

Methods

Methods

comments

Parameters

Returns Promise<GitHubPagedResponse<GitHubIssueComment>>

get

Returns Promise<GitHubIssue>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

Settings

On This Page