Giter VIP home page Giter VIP logo

gh-account-exists's Introduction

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.

gh-account-exists's People

Contributors

shinnn avatar simonepri avatar

Stargazers

Tuan Duc Tran avatar Georgey avatar Raju Udava avatar YoungChief avatar Khaleel Gibran avatar Jannis R avatar

Watchers

 avatar

Forkers

simonepri

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.