| 1 | # JSherLock
|
| 2 |
|
| 3 | > Find usernames across social networks
|
| 4 |
|
| 5 | [![Build Status][travis]][travis-url]
|
| 6 | [![code style: prettier][prettier]][prettier-url]
|
| 7 | [![npm][npm-download]][npm-dl-url]
|
| 8 | [![contributions welcome][contri]][contri-url]
|
| 9 | [![License: MIT][license]][license-url]
|
| 10 |
|
| 11 | ## Install
|
| 12 |
|
| 13 | ```shell
|
| 14 | npm install jsherlock
|
| 15 | ```
|
| 16 |
|
| 17 | ## API
|
| 18 |
|
| 19 | - [ checkAll ](#checkAll)
|
| 20 | - [ checkFor ](#checkFor)
|
| 21 | - [ sites ](#sites)
|
| 22 |
|
| 23 | ### checkAll
|
| 24 |
|
| 25 | check username availability across social networks
|
| 26 |
|
| 27 | ### Example
|
| 28 |
|
| 29 | ```javascript
|
| 30 | import JsherLock from 'jsherlock';
|
| 31 |
|
| 32 | const checker = new JsherLock('username');
|
| 33 |
|
| 34 | checker
|
| 35 | .checkAll()
|
| 36 | .then(status => {
|
| 37 | console.log(status);
|
| 38 | })
|
| 39 | .catch(err => {
|
| 40 | throw err;
|
| 41 | });
|
| 42 |
|
| 43 | //=> [
|
| 44 | //=> {
|
| 45 | //=> "userName": "username",
|
| 46 | //=> "siteName": "siteName",
|
| 47 | //=> "url": "url://url.url/username",
|
| 48 | //=> "exist": false
|
| 49 | //=> }
|
| 50 | //=> ]
|
| 51 | ```
|
| 52 |
|
| 53 | ### checkFor
|
| 54 |
|
| 55 | check username availability for individual site
|
| 56 |
|
| 57 | ### Example
|
| 58 |
|
| 59 | ```javascript
|
| 60 | import JsherLock from 'jsherlock';
|
| 61 |
|
| 62 | const checker = new JsherLock('username');
|
| 63 |
|
| 64 | checker
|
| 65 | .checkFor('site')
|
| 66 | .then(status => {
|
| 67 | console.log(status);
|
| 68 | })
|
| 69 | .catch(err => {
|
| 70 | throw err;
|
| 71 | });
|
| 72 |
|
| 73 | //=> {
|
| 74 | //=> "userName": "username",
|
| 75 | //=> "siteName": "siteName",
|
| 76 | //=> "url": "url://url.url/username",
|
| 77 | //=> "exist": false
|
| 78 | //=> }
|
| 79 | ```
|
| 80 |
|
| 81 | ### sites
|
| 82 |
|
| 83 | available sites
|
| 84 |
|
| 85 | ### Example
|
| 86 |
|
| 87 | ```javascript
|
| 88 | import JsherLock from 'jsherlock';
|
| 89 |
|
| 90 | const sites = JsherLock.sites();
|
| 91 |
|
| 92 | console.log(sites);
|
| 93 |
|
| 94 | //=> ["site"]
|
| 95 | ```
|
| 96 |
|
| 97 | ## Related
|
| 98 |
|
| 99 | - [ jsherlock-cli ][jsherlock-cli]
|
| 100 |
|
| 101 | ## Inspired by
|
| 102 |
|
| 103 | - [sherlock][inspired-by]
|
| 104 |
|
| 105 | ## LICENSE
|
| 106 |
|
| 107 | MIT © [Aung Myo Kyaw](https://github.com/AungMyoKyaw)
|
| 108 |
|
| 109 | [inspired-by]: https://github.com/TheYahya/sherlock
|
| 110 | [jsherlock-cli]: https://github.com/AungMyoKyaw/jsherlock-cli
|
| 111 | [contri]: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square
|
| 112 | [contri-url]: https://github.com/AungMyoKyaw/jsherlock/issues
|
| 113 | [travis]: https://img.shields.io/travis/AungMyoKyaw/jsherlock/master.svg?style=flat-square
|
| 114 | [travis-url]: https://travis-ci.org/AungMyoKyaw/jsherlock
|
| 115 | [npm-download]: https://img.shields.io/npm/dt/jsherlock.svg?style=flat-square
|
| 116 | [npm-dl-url]: https://www.npmjs.com/package/jsherlock
|
| 117 | [license]: https://img.shields.io/badge/License-MIT-brightgreen.svg?style=flat-square
|
| 118 | [license-url]: https://opensource.org/licenses/MIT
|
| 119 | [prettier]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
|
| 120 | [prettier-url]: https://github.com/prettier/prettier
|