Merge pull request #113 from actions/client-options

Accept Octokit.Options in the GitHub constructor
actions · Sep 5, 2019 · 7772d5f · 7772d5f
2 parents eb4c328 + 1c4866f
commit 7772d5f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -26,6 +26,6 @@
     "lerna": "^3.13.3",
     "prettier": "^1.17.0",
     "ts-jest": "^24.0.2",
-    "typescript": "^3.4.4"
+    "typescript": "^3.6.2"
   }
 }
diff --git a/packages/github/README.md b/packages/github/README.md
@@ -27,6 +27,8 @@ const { data: pullRequest } = await octokit.pulls.get({
 console.log(pullRequest);
 ```
 
+You can pass client options (except `auth`, which is handled by the token argument), as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor.
+
 You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API.
 
 ```js

diff --git a/packages/github/src/github.ts b/packages/github/src/github.ts
@@ -14,8 +14,8 @@ export class GitHub extends Octokit {
     variables?: Variables
   ) => Promise<GraphQlQueryResponse>
 
-  constructor(token: string) {
-    super({auth: `token ${token}`})
+  constructor(token: string, opts: Omit<Octokit.Options, 'auth'> = {}) {
+    super({...opts, auth: `token ${token}`})
     this.graphql = defaults({
       headers: {authorization: `token ${token}`}
     })
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,6 +27,8 @@ const { data: pullRequest } = await octokit.pulls.get({ @@
     console.log(pullRequest);
     ```
+    You can pass client options (except `auth`, which is handled by the token argument), as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor.
     You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API.
     ```js
@@ Expand Down @@