Extra HTTP headers can be passed with CreateOptions (#223)

Author: rgba

src/CreateOptions.ts

@@ -93,6 +93,14 @@ export interface CreateOptions {
    */
   cookies?: SetCookieOptions[];
 
+  /**
+   * Extra HTTP headers to send when making a request.
+   *
+   * @type {[key: string]: string}
+   * @memberof CreateOptions
+   */
+  extraHTTPHeaders?: { [key: string]: string; };
+
   /**
    * Set a callback to receive console messages.
    *

src/index.ts

@@ -122,6 +122,9 @@ async function beforeNavigate(options: CreateOptions, client: any): Promise<void
       options._navigateFailed = true;
     }
   });
+  if (options.extraHTTPHeaders) {
+    Network.setExtraHTTPHeaders({headers: options.extraHTTPHeaders});
+  }
   if (options.cookies) {
     await throwIfCanceledOrFailed(options);
     await Network.setCookies({cookies: options.cookies});

test/index.ts

@@ -121,6 +121,23 @@ describe('HtmlPdf', () => {
       expect(pdf.getRawTextContent()).to.startWith('Cookies:status=Passed!');
     });
 
+    it('should generate a PDF and send extra http headers', async () => {
+      const options: HtmlPdf.CreateOptions = {
+        port,
+        extraHTTPHeaders: {
+            'X-Custom-Test-Header1' : 'Passed1!',
+            'X-Custom-Test-Header2' : 'Passed2!',
+        },
+      };
+
+      const result = await HtmlPdf.create('http://httpbin.org/headers', options);
+      const pdf = await getParsedPdf(result.toBuffer());
+      const rawTextContent = pdf.getRawTextContent();
+
+      expect(rawTextContent).to.contain('X-Custom-Test-Header1').and.to.contain('Passed1!');
+      expect(rawTextContent).to.contain('X-Custom-Test-Header2').and.to.contain('Passed2!');
+    });
+
     it('should proxy console messages', async () => {
       const events: ConsoleAPICalled[] = [];
       const options: HtmlPdf.CreateOptions = {