Up: Authentication using OctoKit   [Index]


1.3.1 OctoKit Object Options

Here are the available options:

authStrategy

(function) defaults to @octokit/auth-token.

auth
baseURL

for use with GitHub Enterprise Server

previews

Some REST API endpoints require preview headers to be set, or enable additional features. Preview headers can be set on a per-request basis, e.g.

request
timeZone
userAgent
const octokit = new Octokit({
  option1: value,
  option2: value,
})