star-gist v1.0.0

star-gist

Star a gist

const starGist = require('star-gist');

starGist('2790533', {token: 'xxxx'}).then(response => {
  response.statusCode; //=> 204
  console.log('Starred a gist: https://gist.github.com/2790533');
});

Installation

Use npm.

npm install star-gist

API

const starGist = require('star-gist');

starGist(gistId , options)

gistId: String (a gist ID, for example https://gist.github.com/tim/34309 → '34309')
options: Object (gh-get options)
Return: Promise instance

It makes an API request to star a gist by the authenticated user, and returns a promise.

The promise will be fulfilled with an http.IncomingMessage object if successful, otherwise rejected with an error.

starGist('ab12852099', {token: 'xxxxxx'}).catch(err => {
  err.message;
  //=> '404 Not Found (Gist not found: https://gist.github.com/ab12852099)'
});

starGist('2790533', {token: 'invalid_token'}).catch(err => {
  err.message;
  //=> '401 Unauthorized (Bad credentials)'
});

Related Projects

• is-gist-starred (Check if you have starred a given gist or not)
• unstar-gist (Unstar a gist)

License

Copyright (c) 2015 Shinnosuke Watanabe

Licensed under the MIT License.