npm.io
1.0.7 • Published 10 years ago

github-url-exists

Licence
MIT
Version
1.0.7
Deps
1
Vulns
1
Weekly
0
Stars
2

github-url-exists Build Status

Check if a URL is a valid and existent GitHub HTTP(s) URL

Installation

$ npm install --save github-url-exists

Usage

var githubUrlExists = require('github-url-exists');

githubUrlExists('https://github.com/alferov/awesome-gulp', function(err, valid) {
  if (err) {
    // Handle errors
  }

  console.log(valid); // => true
});

githubUrlExists('https://github.com/alferov/awesome-gulp.git', function(err, valid) {
  if (err) {
    // Handle errors
  }

  console.log(valid); // => true
});

githubUrlExists('https://github.com/notthepage/notthepage', function(err, valid) {
  if (err) {
    // Handle errors
  }

  console.log(valid); // => false
});

githubUrlExists('google.com/', function(err, valid) {
  if (err) {
    // Handle errors
  }

  console.log(valid); // => false
});

//Warning: The package doesn't support ssh protocol
githubUrlExists('git@github.com:alferov/awesome-gulp.git', function(err, valid) {
  if (err) {
    // Handle errors
  }

  console.log(valid); // => false
});

API

githubUrlExists(url, cb)

Check if a URL is a valid and existent GitHub HTTP(s) URL

Params
  • String url: A string to be validated
  • Function cb: The callback function

License

MIT Philipp Alferov

Keywords