rollodeqc-gh-utils

RoLLodeQc GitHub utilities.

Install

$ npm install --save rollodeqc-gh-utils

Usage

const rollodeqcGhUtils = require('rollodeqc-gh-utils')
 
rollodeqcGhUtils.rateLimit().then((result) => {
  console.log(JSON.stringify(result, null, ' '))
})
//=>
{
 "rate": {
  "limit": 5000,
  "remaining": 5000,
  "reset": 1459470151
 },
 "headers": {
  "server": "GitHub.com",
  "date": "Thu, 31 Mar 2016 23:22:31 GMT",
  "status": "200 OK",
  "x-ratelimit-limit": 5000,
  "x-ratelimit-remaining": 5000,
  "x-ratelimit-reset": 1459470151,
  "timestamp": 1459466551,
  "timestampDiff": 2.87,
  "statusCode": 200
 }
}

API

rollodeqcGhUtils.got(url[, obj])

Fetch json documents from GitHub. Like ghGot with a little sugar added. Only some headers are kept and parsed.

Returns a promise.

url

Type: string

obj

Type: object
Default: {}

See ghGot. Good for token, etc. Note that the token can be overridden globally with the GITHUB_TOKEN environment variable.

rollodeqcGhUtils.rateLimit()

Fetch current rate limit and return a promise.

rollodeqcGhUtils.links(result)

Parses result.headers.link and returns an object with next, previous and last links.

result

Type: object

rollodeqcGhUtils.wait(result)

Return time to wait (in ms) between calls to got() to respect the rate limit.

result

Type: object

rollodeqcGhUtils.chosenHeaders(headers)

Lorem ipsum.

headers

Type: object

rollodeqcGhUtils.chosenFields(fields)

Lorem ipsum.

fields

Type: object

Dependencies

• gh-got
• lodash.pickby
• lodash.omitby
• lodash.flow
• lodash.partial

License

AGPL-v3 © Robin Millette