Followers
Get a user's followers.
Installation
$ npm install github-followers
Usage
var followers = ;
followers( opts, clbk )
Gets a user's followers.
var opts ='username': 'kgryte';;{// Check for rate limit information...if infoconsole;console;console;if errorthrow errormessage ;console;// returns <follower_data>}
The function
accepts the following options
:
- token: Github access token.
- username: Github username.
- useragent: user agent
string
.
To authenticate with Github, set the token
option.
var opts ='token': 'tkjorjk34ek3nj4!';;
To get the followers of a particular user, set the username
option.
var opts ='username': 'kgryte';;
To specify a user agent, set the useragent
option.
var opts ='useragent': 'hello-github!';;
followers.factory( options, clbk )
Creates a reusable function
.
var opts ='username': 'kgryte''token': 'tkjorjk34ek3nj4!';var get = followers;;;;// ...
The factory method accepts the same options
as followers()
.
Notes
- Either a
username
or atoken
or both must be provided. If provided atoken
, but not ausername
, thefunction
fetches the authenticated user's Github followers. - Rate limit information includes the following:
- limit: maximum number of requests a consumer is permitted to make per hour.
- remaining: number of remaining requests.
- reset: time at which the current rate limit window resets in UTC seconds.
Examples
var followers = ;var opts ='useragent': 'beep-boop-bop''token': 'tkjorjk34ek3nj4!';;{if infoconsole;if errorthrow errormessage ;console;}
To run the example code from the top-level application directory,
$ DEBUG=* node ./examples/index.js
Note: in order to run the example, you will need to obtain an access token and modify the token
option accordingly.
CLI
Installation
To use the module as a general utility, install the module globally
$ npm install -g github-followers
Usage
Usage: ghfollowers [options]Options:-h, --help Print this message.-V, --version Print the package version.--token token Github access token.--username username Github username.-ua, --useragent ua User agent.
Notes
- In addition to the
token
option, the token may also be specified by aGITHUB_TOKEN
environment variable. The command-line option always takes precedence. - Request resources are written to
stdout
. - Rate limit information is written to
stderr
.
Examples
Setting the access token using the command-line option:
$ DEBUG=* ghfollowers --token <token> --username 'kgryte'# => '[{...},{...},...]'
Setting the access token using an environment variable:
$ DEBUG=* GITHUB_TOKEN=<token> ghfollowers --username 'kgryte'# => '[{...},{...},...]'
For local installations, modify the command to point to the local installation directory; e.g.,
$ DEBUG=* ./node_modules/.bin/ghfollowers --token <token> --username 'kgryte'# => '[{...},{...},...]'
Or, if you have cloned this repository and run npm install
, modify the command to point to the executable; e.g.,
$ DEBUG=* node ./bin/cli --token <token> --username 'kgryte'# => '[{...},{...},...]'
Tests
Unit
This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. Athan Reines.