Class GistResource

Provides access to GitHub Gist endpoints.

Obtained via GitHubClient.gist(gistId) for single-gist operations, or use the static list methods directly on the client.

Example

const gist = await gh.gist('abc123');
const comments = await gh.gist('abc123').comments();
await gh.gist('abc123').star();

Implements

PromiseLike<GitHubGist>

Index

Methods

addComment comments commits delete deleteComment fork forks get isStarred star then unstar update updateComment

Methods

addComment

addComment(data: GistCommentData, signal?: AbortSignal): Promise<GistComment>
Creates a comment on a gist.

POST /gists/{gist_id}/comments
Parameters
- data: GistCommentData
- Optionalsignal: AbortSignal
Returns Promise<GistComment>
- Defined in src/resources/GistResource.ts:158

comments

comments(
params?: { page?: number; per_page?: number },
signal?: AbortSignal,
): Promise<GitHubPagedResponse<GistComment>>
Lists comments on a gist.

GET /gists/{gist_id}/comments
Parameters
- Optionalparams: { page?: number; per_page?: number }
- Optionalsignal: AbortSignal
Returns Promise<GitHubPagedResponse<GistComment>>
- Defined in src/resources/GistResource.ts:145

commits

commits(
params?: { page?: number; per_page?: number },
signal?: AbortSignal,
): Promise<GitHubPagedResponse<GistCommit>>
Lists commits for a gist.

GET /gists/{gist_id}/commits
Parameters
- Optionalparams: { page?: number; per_page?: number }
- Optionalsignal: AbortSignal
Returns Promise<GitHubPagedResponse<GistCommit>>
- Defined in src/resources/GistResource.ts:77

delete

delete(signal?: AbortSignal): Promise<void>
Deletes a gist.

DELETE /gists/{gist_id}
Parameters
- Optionalsignal: AbortSignal
Returns Promise<void>
- Defined in src/resources/GistResource.ts:68

deleteComment

deleteComment(commentId: number, signal?: AbortSignal): Promise<void>
Deletes a comment on a gist.

DELETE /gists/{gist_id}/comments/{comment_id}
Parameters
- commentId: number
- Optionalsignal: AbortSignal
Returns Promise<void>
- Defined in src/resources/GistResource.ts:176

fork

fork(signal?: AbortSignal): Promise<GitHubGist>
Forks a gist.

POST /gists/{gist_id}/forks
Parameters
- Optionalsignal: AbortSignal
Returns Promise<GitHubGist>
- Defined in src/resources/GistResource.ts:90

forks

forks(
params?: { page?: number; per_page?: number },
signal?: AbortSignal,
): Promise<GitHubPagedResponse<GistFork>>
Lists forks of a gist.

GET /gists/{gist_id}/forks
Parameters
- Optionalparams: { page?: number; per_page?: number }
- Optionalsignal: AbortSignal
Returns Promise<GitHubPagedResponse<GistFork>>
- Defined in src/resources/GistResource.ts:99

get

get(signal?: AbortSignal): Promise<GitHubGist>
Fetches a single gist.

GET /gists/{gist_id}
Parameters
- Optionalsignal: AbortSignal
Returns Promise<GitHubGist>
- Defined in src/resources/GistResource.ts:50

isStarred

isStarred(signal?: AbortSignal): Promise<boolean>
Checks whether the authenticated user has starred a gist. Returns true if starred (HTTP 204), false if not (HTTP 404).

GET /gists/{gist_id}/star
Parameters
- Optionalsignal: AbortSignal
Returns Promise<boolean>
- Defined in src/resources/GistResource.ts:131

star

star(signal?: AbortSignal): Promise<void>
Stars a gist for the authenticated user.

PUT /gists/{gist_id}/star
Parameters
- Optionalsignal: AbortSignal
Returns Promise<void>
- Defined in src/resources/GistResource.ts:112

then

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

unstar

unstar(signal?: AbortSignal): Promise<void>
Unstars a gist for the authenticated user.

DELETE /gists/{gist_id}/star
Parameters
- Optionalsignal: AbortSignal
Returns Promise<void>
- Defined in src/resources/GistResource.ts:121

update

update(data: UpdateGistData, signal?: AbortSignal): Promise<GitHubGist>
Updates an existing gist.

PATCH /gists/{gist_id}
Parameters
- data: UpdateGistData
- Optionalsignal: AbortSignal
Returns Promise<GitHubGist>
- Defined in src/resources/GistResource.ts:59

updateComment

updateComment(
    commentId: number,
    data: GistCommentData,
    signal?: AbortSignal,
): Promise<GistComment>
Updates a comment on a gist.

PATCH /gists/{gist_id}/comments/{comment_id}
Parameters
- commentId: number
- data: GistCommentData
- Optionalsignal: AbortSignal
Returns Promise<GistComment>
- Defined in src/resources/GistResource.ts:167

Class GistResource

Example

Implements

Index

Methods

Methods

addComment

Parameters

Returns Promise<GistComment>

comments

Parameters

Returns Promise<GitHubPagedResponse<GistComment>>

commits

Parameters

Returns Promise<GitHubPagedResponse<GistCommit>>

delete

Parameters

Returns Promise<void>

deleteComment

Parameters

Returns Promise<void>

fork

Parameters

Returns Promise<GitHubGist>

forks

Parameters

Returns Promise<GitHubPagedResponse<GistFork>>

get

Parameters

Returns Promise<GitHubGist>

isStarred

Parameters

Returns Promise<boolean>

star

Parameters

Returns Promise<void>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

unstar

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<GitHubGist>

updateComment

Parameters

Returns Promise<GistComment>

Settings

On This Page