gists   

> Methods for working with the GitHub Gist API. Node.js/JavaScript

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

``sh
$ npm install --save gists
`

Full support for:

* Gist API
* Gist Comments API

_(If you find something missing or encounter a bug, please create an issue. Thanks!)_

Heads up!

Breaking changes in v2.0!!!

Please read the CHANGELOG for more details.

Usage

Add gists to your node.js/JavaScript project with the following code:

`js
const Gists = require('gists');
const gists = new Gists({
username: 'your_username',
password: 'your_password'
});

// EXAMPLE: Download the Markdown Cheatsheet gist.
gists.get('5854601')
.then(res => console.log(res))
.catch(console.error)
`

API

See the GitHub Gist API documentation for additional details and input options for each method.

$3

The main export is the Gists class. Start by creating an instance of Gists.

Params

* options {Object}

Example

`js
// see github-base for all available options and other ways to authenticate
const Gists = require('gists');
const gists = new Gists({ username: 'your_username', password: '*' });

// all methods, when invoked, return a promise with this sigature
gists.get(...args)
.then(res => console.log(res.body))
.catch(console.error);
`

$3

Create a new gist (docs).

Params

* options {Object}: Options to pass to github-base.

Example

`js
// POST /gists
gists.create(options);
`

$3

Get a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to get.
* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/:gist_id
gists.get(gist_id[, options]);
`

$3

List all gists for the given username (docs).

Params

* username {String}
* options {Object}: Options to pass to github-base.

Example

`js
// GET /users/:username/gists
gists.list(username[, options]);
`

$3

List the authenticated user's gists, or if called anonymously get all public gists. (docs).

Params

* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/
gists.all(options);
`

$3

List all public gists sorted by most recently updated to least recently updated (docs).

Params

* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/public
gists.public(options);
`

$3

List the authenticated user's starred gists (docs).

Params

* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/starred
gists.starred(options);
`

$3

Get a specific revision of a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to get.
* sha {String}: (required) The sha of the gist revision to get.
* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/:gist_id/:sha
gists.revision(gist_id, sha[, options]);
`

$3

List commits for a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to get commits for.
* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/:gist_id/commits
gists.commit(gist_id[, options]);
`

$3

List all forks for a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to list forks for.
* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/:gist_id/forks
gists.forks(gist_id[, options]);
`

$3

Fork a gist (docs).

Params

* gist_id {String}: The id of the gist to fork.
* options {Object}: Options to pass to github-base.

Example

`js
// POST /gists/:gist_id/forks
gists.fork(gist_id[, options]);
`

$3

Edit a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to edit.
* options {Object}: Options to pass to github-base.

Example

`js
// PATCH /gists/:gist_id
gists.edit(gist_id[, options]);
`

$3

Delete a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to delete.
* options {Object}: Options to pass to github-base.

Example

`js
// DELETE /gists/:gist_id
gists.delete(gist_id[, options]);
`

$3

Star a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to star.
* options {Object}: Options to pass to github-base.

Example

`js
// PUT /gists/:gist_id/star
gists.star(gist_id[, options]);
`

$3

Unstar a gist (docs).

Params

* gist_id {String}: (required) The id of the gist to unstar.
* options {Object}: Options to pass to github-base.

Example

`js
// DELETE /gists/:gist_id/star
gists.unstar(gist_id[, options]);
`

$3

Check if a gist is starred (docs).

Params

* gist_id {String}: (required) The id of the gist to check.
* options {Object}: Options to pass to github-base.
* returns {Boolean}: Returns true if a gist is starred.

Example

`js
// GET /gists/:gist_id/star
gists.isStarred(gist_id[, options])
`

$3

Create a comment on a gist (docs).

Params

* gist_id {String}: (required)
* options {Object}: Options to pass to github-base.

Example

`js
// POST /gists/:gist_id/comments
gists.comment(gist_id, { body: 'Just commenting for the sake of commenting' });
`

$3

Get a single comment from a gist (docs).

Params

* gist_id {String}: (required)
* comment_id {String}: (required) The id of the comment to get.
* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/:gist_id/comments/:comment_id
gists.getComment(gist_id, comment_id, options);
`

$3

List comments on a gist (docs).

Params

* gist_id {String}: (required)
* options {Object}: Options to pass to github-base.

Example

`js
// GET /gists/:gist_id/comments
gists.listComments(options);
`

$3

Edit a comment (docs).

Params

* gist_id {String}: (required)
* comment_id {String}: (required) The id of the comment to edit.
* options {Object}: Options to pass to github-base.

Example

`js
// PATCH /gists/:gist_id/comments/:gist_id
gists.editComment(gist_id, comment_id[, options]);
`

$3

Delete a comment (docs).

Params

* gist_id {String}: (required)
* comment_id {String}: (required) The id of the comment to edit.
* options {Object}: Options to pass to github-base.

Example

`js
// DELETE /gists/:gist_id/comments/:comment_id
gists.deleteComment(gist_id, comment_id[, options]);
`

Release history

$3

* Decrecated .download in favor of .get. Start using .get now, as .download will be removed in the next major release.
* Decrecated .del in favor of .delete. Start using .delete now, as .del will be removed in the next major release.
* Upgraded github-base, which is now an ES6 class.

About

$3

You might also be interested in these projects:

* github-base: Low-level methods for working with the GitHub API in node.js/JavaScript. | homepage
* github-contributors: Generate a markdown or JSON list of contributors for a project using the GitHub API. | homepage

$3

| Commits | Contributor |
| --- | --- |
| 15 | jonschlinkert |
| 6 | tennisonchan |
| 4 | doowb |
| 1 | sheeit |

$3

Jon Schlinkert

* GitHub Profile
* Twitter Profile
* LinkedIn Profile

$3

Copyright © 2018, Jon Schlinkert.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.6.0, on August 19, 2018._