Skip to content
Find usernames across social networks
Branch: master
Clone or download
Latest commit 01ba56d Feb 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.editorconfig
.gitignore
.npmrc
.prettierrc
.travis.yml
LICENSE
package.json 0.0.7 Feb 12, 2019
readme.md
tsconfig.json

readme.md

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

You can’t perform that action at this time.