readme.md

JSherLock

Find usernames across social networks

Install

npm install jsherlock

API

• checkAll
• checkFor
• sites

checkAll

check username availability across social networks

Example

import jsherlock from 'jsherlock';

const checker = new jsherlock('username');

checker
  .checkAll()
  .then(status => {
    console.log(status);
  })
  .catch(err => {
    console.log(err);
  });

//=> [
//=>   {
//=>     "userName": "username",
//=>     "siteName": "siteName",
//=>     "uri": "url://url.url/username",
//=>     "exist": false
//=>   }
//=> ]

checkFor

check username availability for individual site

Example

import jsherlock from 'jsherlock';

const checker = new jsherlock('username');

checker
  .checkFor('site')
  .then(status => {
    console.log(status);
  })
  .catch(err => {
    console.log(err);
  });

//=>  {
//=>    "userName": "username",
//=>    "siteName": "siteName",
//=>    "uri": "url://url.url/username",
//=>    "exist": false
//=>  }

sites

available sites

Example

import jsherlock from 'jsherlock';

const sites = jsherlock.sites();

console.log(sites);

//=>  ["site"]

Related

• jsherlock-cli

Inspired by

• sherlock

LICENSE

MIT © Aung Myo Kyaw