gh-api-headers v1.0.1

gh-api-headers

Provides default headers for GitHub v3 API requests in Node and the browser.

Mostly used internally across modules. See gh-api-stream and gh-api for more practical implementations.

Install

npm install gh-api --save

Example

You can pass a token, as well as any options you might pass to request or xhr. Examples: body, method, and headers overrides.

var getHeaders = require('gh-api-headers')
var headers = getHeaders({ token: '...' })

Result in Node:

{ 
  accept: 'application/vnd.github.v3+json',
  authorization: 'token ...', 
  'user-agent': 'https://github.com/Jam3/gh-api-headers'
}

In the browser, user-agent is ignored.

{ 
  accept: 'application/vnd.github.v3+json',
  authorization: 'token ...', 
}

Usage

headers = getHeaders([opt])

Takes options for a request and returns headers object that will be suitable for the GitHub v3 API.

All params are optional.

• token - the GitHub authorization token
• headers - an object of headers to use by default for User-Agent and Accept (lower case keys also valid)
• method - if set to "PUT" and body is empty, Content-Length header will be set to zero
• body - if truthy, content-length will not be changed on PUT requests

If headers is passed, the returned headers object will be the same but with any defaults mixed in.

License

MIT, see LICENSE.md for details.