feat(options): add timeZone option to constructor

Author: copperwall

src/index.ts

@@ -62,6 +62,10 @@ export class Octokit {
       requestDefaults.mediaType.previews = options.previews;
     }
 
+    if (options.timeZone) {
+      requestDefaults.headers["time-zone"] = options.timeZone;
+    }
+
     if (options.auth) {
       if (typeof options.auth === "string") {
         requestDefaults.headers.authorization = withAuthorizationPrefix(

src/types.ts

@@ -6,6 +6,7 @@ import { Octokit } from ".";
 export type OctokitOptions = {
   auth?: string | AutenticationHook;
   request?: OctokitRequestOptions;
+  timeZone?: string;
   [option: string]: any;
 };
 

test/defaults.test.ts

@@ -63,6 +63,33 @@ describe("Octokit.defaults", () => {
     });
   });
 
+  it("Octokit.defaults({timeZone})", () => {
+    const mock = fetchMock.sandbox().getOnce(
+      "https://api.github.com/",
+      { ok: true },
+      {
+        headers: {
+          accept: "application/vnd.github.v3+json",
+          "user-agent": userAgent,
+          "time-zone": "Europe/Amsterdam"
+        }
+      }
+    );
+
+    const OctokitWithDefaults = Octokit.defaults({
+      timeZone: "Europe/Amsterdam",
+      request: {
+        fetch: mock
+      }
+    });
+
+    const octokit = new OctokitWithDefaults();
+
+    return octokit.request("GET /").then(response => {
+      expect(response.data).toStrictEqual({ ok: true });
+    });
+  });
+
   it("Octokit.defaults({auth})", async () => {
     const mock = fetchMock.sandbox().getOnce(
       "https://api.github.com/app",

test/request.test.ts

@@ -75,6 +75,31 @@ describe("octokit.request()", () => {
     });
   });
 
+  it("custom time zone", () => {
+    const mock = fetchMock.sandbox().getOnce(
+      "https://api.github.com/",
+      { ok: true },
+      {
+        headers: {
+          accept: "application/vnd.github.v3+json",
+          "user-agent": userAgent,
+          "time-zone": "Europe/Amsterdam"
+        }
+      }
+    );
+
+    const octokit = new Octokit({
+      timeZone: "Europe/Amsterdam",
+      request: {
+        fetch: mock
+      }
+    });
+
+    return octokit.request("GET /").then(response => {
+      expect(response.data).toStrictEqual({ ok: true });
+    });
+  });
+
   it("previews", async () => {
     const mock = fetchMock
       .sandbox()