Check whether a gist is starred | GitHub API (unofficial showcase)

1 parameter

gist_idstringrequired

The unique identifier of the gist whose star status to check.

4 status codes

204Returns no content when the gist is starred by the authenticated user.

304Returned when the gist's star status has not changed since the last request.

403Returned when the authenticated user is not permitted to check the gist's star status.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Returned when the authenticated user has not starred the gist.

Error handling

A 403 is returned when the authenticated user cannot check the gist's star status. A 404 is returned when the authenticated user has not starred the gist identified by the gist_id path parameter.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.star.list({ gistId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors