Have ideas to improve npm?Join in the discussion! »

    gh-username-available

    1.0.4 • Public • Published

    gh-username-available

    Find out whether a GitHub username is available or taken

    Build Status

    js-semistandard-style

    Install

    $ npm install --save gh-username-available
    

    Usage

    var ghUsernameAvailable = require('gh-username-available');
     
    ghUsernameAvailable('icyflame', function (err, value) {
      console.log(value);
      //=> false
    });
     
    ghUsernameAvailable('harry-potter-1', function (err, value) {
      console.log(value);
      //=> true
    });

    CLI

    $ npm install --global gh-username-available
    
    $ gh-username-available --help
    
      Usage
        $ gh-username-available username
    
      Examples
        $ gh-username-available icyflame
        ✖ Taken
    
        $ gh-username-available harry-potter-1
        ✔ Available
    
    

    API

    ghUsernameAvailable(username, callback)

    username

    Required
    Type: string

    Username that you are trying to check

    callback(err, value)

    Required

    value is true if the username is available, and false if it is taken.

    License

    MIT © Siddharth Kannan

    Install

    npm i gh-username-available

    DownloadsWeekly Downloads

    2

    Version

    1.0.4

    License

    MIT

    Last publish

    Collaborators

    • avatar