No description or website provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig
.gitattributes
.gitignore
.travis.yml
LICENSE.txt
cli.js
index.js
package.json
readme.md
test.js
yarn.lock

readme.md

rollodeqc-gh-users

Build Status Coverage Status Dependency Status

RoLLodeQc utility to fetch all GitHub users according to search.

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-users.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.

Install

$ npm install --save rollodeqc-gh-users

Usage

FIXME: readme not up to date

const rollodeqcGhUsers = require('rollodeqc-gh-users');

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

API

rollodeqcGhUsers(input, [options])

input

Type: string

Lorem ipsum.

options

foo

Type: boolean
Default: false

Lorem ipsum.

Dependencies

  • gh-user
  • rate-limit-promise
  • rollodeqc-gh-search-users-all
  • rollodeqc-gh-utils

License

AGPL-v3 © Robin Millette