\n \n \n options.authStrategy\n | \n \n Function\n | \n \n Defaults to @octokit/auth-token. See Authentication below for examples.\n | \n
\n \n \n options.auth\n | \n \n String or Object\n | \n \n See Authentication below for examples.\n | \n
\n \n \n options.baseUrl\n | \n \n String\n | \n \n\nWhen using with GitHub Enterprise Server, set `options.baseUrl` to the root URL of the API. For example, if your GitHub Enterprise Server's hostname is `github.acme-inc.com`, then set `options.baseUrl` to `https://github.acme-inc.com/api/v3`. Example\n\n```js\nconst octokit = new Octokit({\n baseUrl: \"https://github.acme-inc.com/api/v3\",\n});\n```\n\n |
\n \n \n options.previews\n | \n \n Array of Strings\n | \n \n\nSome REST API endpoints require preview headers to be set, or enable\nadditional features. Preview headers can be set on a per-request basis, e.g.\n\n```js\noctokit.request(\"POST /repos/{owner}/{repo}/pulls\", {\n mediaType: {\n previews: [\"shadow-cat\"],\n },\n owner,\n repo,\n title: \"My pull request\",\n base: \"main\",\n head: \"my-feature\",\n draft: true,\n});\n```\n\nYou can also set previews globally, by setting the `options.previews` option on the constructor. Example:\n\n```js\nconst octokit = new Octokit({\n previews: [\"shadow-cat\"],\n});\n```\n\n |
\n \n \n options.request\n | \n \n Object\n | \n \n\nSet a default request timeout (`options.request.timeout`) or an [`http(s).Agent`](https://nodejs.org/api/http.html#http_class_http_agent) e.g. for proxy usage (Node only, `options.request.agent`).\n\nThere are more `options.request.*` options, see [`@octokit/request` options](https://github.com/octokit/request.js#request). `options.request` can also be set on a per-request basis.\n\n |
\n \n \n options.timeZone\n | \n \n String\n | \n \n\nSets the `Time-Zone` header which defines a timezone according to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\n```js\nconst octokit = new Octokit({\n timeZone: \"America/Los_Angeles\",\n});\n```\n\nThe time zone header will determine the timezone used for generating the timestamp when creating commits. See [GitHub's Timezones documentation](https://developer.github.com/v3/#timezones).\n\n |
\n \n \n options.userAgent\n | \n \n String\n | \n \n\nA custom user agent string for your app or library. Example\n\n```js\nconst octokit = new Octokit({\n userAgent: \"my-app/v1.2.3\",\n});\n```\n\n |
\n \n