online-branch-exist

Check that given branch/tag/release exist in github repo, using user/repo#branch pattern.

Install

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

API

For more use-cases see the tests

onlineExist

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

• pattern {String}
• opts {Object} options to pass to got
  • opts.token {String} optional github access token
• 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) {
  console.log(err);
  //=> always null
  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}
• opts {Object} options to pass to got
  • opts.token {String} optional github access token
• callback {Function}

Example:

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

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

.tag

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

• pattern {String}
• opts {Object} options to pass to got
  • opts.token {String} optional github access token
• callback {Function}

Example:

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

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

Related

• is-missing: Check that given name or user/repo exists in npm registry or in github as organization/user repository.
• github-generate-token: Generating Github Personal Access Token using Basic Auth username:password
• gitclone: Clone a Github repository with only username/repo.
• assertit: Thin sugar layer on top of testit framework, is-kindof and assert.
• jstransformer: Normalize the API of any jstransformer

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.

---

Proudly generated by docks(1), April 5, 2015