Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

gh-account-exists

0.1.0 • Public • Published

gh-account-exists

NPM version Build Status Coverage Status

A Node.js module to check if a Github account with the given username exists or not

const ghAccountExists = require('gh-account-exists');
 
ghAccountExists('shinnn').then(exists => {
  console.log(exists); // true
});

Installation

Use npm.

npm install gh-account-exists

API

const ghAccountExists = require('gh-account-exists');

ghAccountExists(username [, options])

username: String (a Github username)
options: Object (gh-get options)
Return: Promise

The returned promise will be resolved with true if the account exists, or resolved with false if it doesn't exist.

// User account
ghAccountExists('tim').then(exists => {
  console.log(exists); // true
});
 
// Organization account
ghAccountExists('nodejs').then(exists => {
  console.log(exists); // true
});
 
// Bot account
ghAccountExists('mention-bot').then(exists => {
  console.log(exists); // true
});
 
// Account that doesn't exist
ghAccountExists('4589iutoiy72euiiujjudjf').then(exists => {
  console.log(exists); // false
});

License

Copyright (c) 2017 Shinnosuke Watanabe

Licensed under the MIT License.

Install

npm i gh-account-exists

DownloadsWeekly Downloads

3

Version

0.1.0

License

MIT

Last publish

Collaborators

  • avatar