fix(typescript): agent client option is optional (#803)

package.json

@@ -101,6 +101,7 @@
     "generate-bundle-report": "webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html",
     "prevalidate:ts": "npm run -s build:ts",
     "validate:ts": "tsc --target es6 index.d.ts",
+    "postvalidate:ts": "tsc --noEmit test/typescript-validate.ts",
     "deploy-docs": "gh-pages-with-token -d doc",
     "semantic-release": "semantic-release",
     "start-fixtures-server": "octokit-fixtures-server"

scripts/templates/index.d.ts.tpl

@@ -43,7 +43,7 @@ declare namespace Github {
     requestMedia?: string;
     rejectUnauthorized?: boolean;
     family?: number;
-    agent: http.Agent;
+    agent?: http.Agent;
   }
 
   export interface AuthBasic  {

test/typescript-validate.ts

@@ -0,0 +1,20 @@
+import * as Octokit from '../'
+
+// ************************************************************
+// THIS CODE IS NOT EXECUTED. IT IS JUST FOR TYPECHECKING
+// ************************************************************
+
+// Test the TypeScript definition.
+export default async function() {
+  // ************************************************************
+  // THIS CODE IS NOT EXECUTED. IT IS JUST FOR TYPECHECKING
+  // ************************************************************
+  new Octokit() // Check empty constructor
+  const octo = new Octokit({}) // Check that all arguments are optional
+  const repo = await octo.repos.get({owner: 'octokit', repo: 'rest.js'})
+  // Check Response
+  repo.data
+  repo.meta.link
+  repo.meta.etag
+  repo.meta.status
+}