Rollodeqc-gh-search-users-all NPM

rollodeqc-gh-search-users-all

RoLLodeQc module to search all GitHub users while respecting rate limits.

Install

$ npm install --save rollodeqc-gh-search-users-all

New since version 0.5.0

The cli now uses update-notifier to let the user know about updates to this program.

Users have the ability to opt-out of the update notifier by changing the optOut property to true in ~/.config/configstore/update-notifier-rollodeqc-gh-search-users-all.json. The path is available in notifier.config.path.

Users can also opt-out by setting the environment variable NO_UPDATE_NOTIFIER with any value or by using the --no-update-notifier flag on a per run basis.

Usage

const rollodeqcGhSearchUsersAll = require('rollodeqc-gh-search-users-all');

rollodeqcGhSearchUsersAll('unicorns');
//=> 'unicorns & rainbows'

API

rollodeqcGhSearchUsersAll(query)

Search all GitHub users while respecting rate limits. Returns a promise.

query

Type: string|object

string values can represent a search query or a complete GitHub API URL (beginning with http:// or https://). Otherwise see the tests and source code if query is an object.