online-branch-exist

Async (with callback api) check through github api if branch/tag/release exists in the user/repo, you can use user/repo[#branch] for the check

Install

npm i --save online-branch-exist
npm test

API

For more use-cases see the tests

onlineBranch

using user/repo#branch you can check if tag or branch exists

• pattern {String}
• token {String|Boolean} github personal access token, or true for public
• callback {Function}

Example:

var onlineExist = require('online-branch-exist');

// first will check if branch exists
// if not exist, will check if tag with name `master` exists
// at last if not exist will return `false`
onlineExist('tunnckoCore/koa-better-body#master', function(err, res) {
  if (err) {
    console.error(err);
    return;
  }
  console.log(res);
  //=> true
})

.branch

Checks that given branch exists in github repo, using user/repo#branch string pattern
Actually same as above.

• pattern {String}
• token {String|Boolean} github personal access token, or true for public
• callback {Function}

Example:

var onlineExist = require('online-branch-exist');

onlineExist.branch('koajs/koa#proxy', function(err, res) {
  if (err) {
    console.error(err);
    return;
  }
  console.log(res);
  //=> true
})

.tag

Checks that given tag exists in github repo, using user/repo#tag string pattern

• pattern {String}
• token {String|Boolean} github personal access token, or true for public
• callback {Function}

Example:

var onlineExist = require('online-branch-exist');

onlineExist.tag('hybridables/handle-arguments#v2.0.0', function(err, res) {
  if (err) {
    console.error(err);
    return;
  }
  console.log(res);
  //=> true
})

Author

Charlike Mike Reagent

• gratipay/tunnckoCore
• twitter/tunnckoCore
• github/tunnckoCore
• npmjs/tunnckoCore
• more ...

License

Copyright (c) 2014-2015 Charlike Mike Reagent, contributors.
Released under the MIT license.

---

Powered and automated by kdf, February 27, 2015