Can now pass in the Electron path.

Author: ashleydavis

package.json

@@ -1,6 +1,6 @@
 {
     "name": "capture-template",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "description": "This library is responsible for expanding a template web page and then capturing it PNG or PDF.",
     "main": "build/index.js",
     "types": "build/index.d.ts",

src/index.ts

@@ -7,8 +7,8 @@ const promisify = require('promisify-any');
 //
 // Initalise the template renderer.
 //
-async function initTemplateRenderer(data: any, templatePath: string, port: number): Promise<ITemplateRenderer> {
-    const templateRenderer = new TemplateRenderer();
+async function initTemplateRenderer(data: any, templatePath: string, port: number, electronPath?: string): Promise<ITemplateRenderer> {
+    const templateRenderer = new TemplateRenderer(electronPath);
     await templateRenderer.start();
     await templateRenderer.loadTemplate(data, templatePath, port);
     return templateRenderer;
@@ -25,21 +25,21 @@ async function deinitTemplateRenderer(templateRenderer: ITemplateRenderer): Prom
 //
 // Expand a template web page and capture it to an image file.
 //
-export async function captureImage(data: any, templatePath: string, outputPath: string): Promise<void> {
+export async function captureImage(data: any, templatePath: string, outputPath: string, electronPath?: string): Promise<void> {
     await fs.ensureDir(path.dirname(outputPath));
     const autoAssignPortNo = 0; // Use port no 0, to automatically assign a port number.
-    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo);
+    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo, electronPath);
     await templateRenderer.renderImage(outputPath);
     await deinitTemplateRenderer(templateRenderer);
 }
 
 //
 // Expand a template web page and capture it to a PDF file.
 //
-export async function capturePDF(data: any, templatePath: string, outputPath: string): Promise<void> {
+export async function capturePDF(data: any, templatePath: string, outputPath: string, electronPath?: string): Promise<void> {
     await fs.ensureDir(path.dirname(outputPath));
     const autoAssignPortNo = 0; // Use port no 0, to automatically assign a port number.
-    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo);
+    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo, electronPath);
     await templateRenderer.renderPDF(outputPath);
     await deinitTemplateRenderer(templateRenderer);
 }

src/template-renderer.ts

@@ -55,6 +55,11 @@ export interface ITemplateRenderer {
  */
 export class TemplateRenderer implements ITemplateRenderer {
 
+    /**
+     * Specifies the path to load Electron from or null to use default path.
+     */
+    electronPath?: string;
+    
     /**
      * Renders the web page.
      */
@@ -65,6 +70,10 @@ export class TemplateRenderer implements ITemplateRenderer {
      */
     private templateWebServer: ITemplateWebServer | null = null;
 
+    constructor (electronPath?: string) {
+        this.electronPath = electronPath;
+    }
+
     /**
      * Get the URL to access the web-sever.
      */
@@ -77,7 +86,7 @@ export class TemplateRenderer implements ITemplateRenderer {
      * For performance reasons the template render can be reused to render multiple web pages.
      */
     async start (): Promise<void> {
-        this.webPageRenderer = new WebPageRenderer();
+        this.webPageRenderer = new WebPageRenderer(this.electronPath);
         await this.webPageRenderer.start();
     }
 

src/web-page-renderer.ts

@@ -51,20 +51,36 @@ export interface IWebPageRenderer {
  */
 export class WebPageRenderer implements IWebPageRenderer {
 
+    /**
+     * Specifies the path to load Electron from or null to use default path.
+     */
+    electronPath?: string;
+
     /**
      * Nightmare headless browser instance.
      */
     nightmare: any | null = null;
 
+    constructor (electronPath?: string) {
+        this.electronPath = electronPath;
+    }
+
     /**
      * Start the web page renderer.
      * For performance reasons this can be reused to render multiple pages.
      */
     async start (): Promise<void> {
-        this.nightmare = new Nightmare({
+        const nightmareOptions: any = {
             show: false,
             frame: false,
-        });
+        };
+
+        if (this.electronPath) {
+            // Include Electron path if specified.
+            nightmareOptions.electronPath = this.electronPath;
+        }
+
+        this.nightmare = new Nightmare(nightmareOptions);
 
         this.nightmare.on('crashed', (evt: any) => {
             throw new Error("Nightmare crashed " + evt.toString());