located-in v1.0.0

located-in

Get users by a speified location.

Install

$ npm install --save located-in

Usage

const locatedIn = require('located-in')

// find users in china or hongkong
locatedIn(['china', 'hongkong'])
  .then(data => {
    console.log(data)
    // {
    //   total_count: 3,                                                                      
    //   incomplete_results: false,                                                           
    //   items: []
    // }
  })

API

locatedIn(locations, options)

locations

Type: array

A list of locations.

options

all

Type: boolean Default: false

Whether to concat all results in one array.

per_page

Type: number Default: 50

50 items per page.

keyword

Type: string Default: ''

The search keyword.

sort

Type: string Default: followers

How to sort the results.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT © EGOIST