Skip to content

AungMyoKyaw/jsherlock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSherLock

Find usernames across social networks

Build Status install size code style: prettier npm contributions welcome License: MIT

Install

npm install jsherlock

API

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

Inspired by

LICENSE

MIT © Aung Myo Kyaw