# github-url-exists

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

Latest version **1.0.7** (published 2015-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-url-exists
pnpm add github-url-exists
yarn add github-url-exists
bun add github-url-exists
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2015-11-06 |
| First published | 2015-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Philipp Alferov |
| Maintainers | alferov |
| Keywords | git, github, validation, link, url, exists, string |

## Links

- npm: https://www.npmjs.com/package/github-url-exists
- Repository: https://github.com/alferov/github-url-exists
- Homepage: https://github.com/alferov/github-url-exists#readme
- Issues: https://github.com/alferov/github-url-exists/issues
- npm.io page: https://npm.io/package/github-url-exists

## Dependencies (1)

- [got](https://npm.io/package/got.md) ^4.2.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2015-11-06
- 1.0.6 — 2015-11-06
- 1.0.5 — 2015-10-27
- 1.0.4 — 2015-10-22
- 1.0.3 — 2015-10-19
- 1.0.2 — 2015-10-19
- 1.0.1 — 2015-10-17

## README

# github-url-exists [![Build Status](https://travis-ci.org/alferov/github-url-exists.svg?branch=master)](https://travis-ci.org/alferov/github-url-exists)

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

## Installation
```
$ npm install --save github-url-exists
```

## Usage
```js
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](https://github.com/alferov)

---
_Source: https://npm.io/package/github-url-exists · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._