Generate html file from Handlebars template and data object












0












$begingroup$


I have a class called HtmlFile which has a method called generate. The generate() method is responsible for generating an html file from handlebars template and data object provided in HtmlFile class's constructor.



I am confused on what code design should I use for this use case and what variable names to choose.



class HtmlFile {
public file: any = null;
private template: any = null;
private data: any = null;
constructor(templatePath: string, params: any) {
this.template = path.resolve(templatePath);
this.data = params;
}

public async generate() {
try {
const error = this._validate();
if (error) {
throw error;
}
const fileContent = fs.readFileSync(this.template, "utf8");
const html = handlebars.compile(fileContent)(this.data);
return html;
} catch (e) {
throw e;
}
}

private _validate() {
let errStr: any = null;
if (typeof this.template !== "string") {
errStr = `expected template path to be a string, instead got
${typeof this.template}`;
}
if (typeof this.data !== "object") {
errStr = `expected data to be an object, instead got ${typeof
this.data}`;
}
return errStr;
}
}


And I am using this class in the following manner



let htmlFile = new HtmlFile("./src/templates/sample.hbs", invoiceOptions);
const html: any = await htmlFile.generate();
return html;


I also want suggestions on what variable names should I use in place of htmlFile and html.



Thanks in advance










share|improve this question







New contributor




Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.







$endgroup$

















    0












    $begingroup$


    I have a class called HtmlFile which has a method called generate. The generate() method is responsible for generating an html file from handlebars template and data object provided in HtmlFile class's constructor.



    I am confused on what code design should I use for this use case and what variable names to choose.



    class HtmlFile {
    public file: any = null;
    private template: any = null;
    private data: any = null;
    constructor(templatePath: string, params: any) {
    this.template = path.resolve(templatePath);
    this.data = params;
    }

    public async generate() {
    try {
    const error = this._validate();
    if (error) {
    throw error;
    }
    const fileContent = fs.readFileSync(this.template, "utf8");
    const html = handlebars.compile(fileContent)(this.data);
    return html;
    } catch (e) {
    throw e;
    }
    }

    private _validate() {
    let errStr: any = null;
    if (typeof this.template !== "string") {
    errStr = `expected template path to be a string, instead got
    ${typeof this.template}`;
    }
    if (typeof this.data !== "object") {
    errStr = `expected data to be an object, instead got ${typeof
    this.data}`;
    }
    return errStr;
    }
    }


    And I am using this class in the following manner



    let htmlFile = new HtmlFile("./src/templates/sample.hbs", invoiceOptions);
    const html: any = await htmlFile.generate();
    return html;


    I also want suggestions on what variable names should I use in place of htmlFile and html.



    Thanks in advance










    share|improve this question







    New contributor




    Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
    Check out our Code of Conduct.







    $endgroup$















      0












      0








      0


      0



      $begingroup$


      I have a class called HtmlFile which has a method called generate. The generate() method is responsible for generating an html file from handlebars template and data object provided in HtmlFile class's constructor.



      I am confused on what code design should I use for this use case and what variable names to choose.



      class HtmlFile {
      public file: any = null;
      private template: any = null;
      private data: any = null;
      constructor(templatePath: string, params: any) {
      this.template = path.resolve(templatePath);
      this.data = params;
      }

      public async generate() {
      try {
      const error = this._validate();
      if (error) {
      throw error;
      }
      const fileContent = fs.readFileSync(this.template, "utf8");
      const html = handlebars.compile(fileContent)(this.data);
      return html;
      } catch (e) {
      throw e;
      }
      }

      private _validate() {
      let errStr: any = null;
      if (typeof this.template !== "string") {
      errStr = `expected template path to be a string, instead got
      ${typeof this.template}`;
      }
      if (typeof this.data !== "object") {
      errStr = `expected data to be an object, instead got ${typeof
      this.data}`;
      }
      return errStr;
      }
      }


      And I am using this class in the following manner



      let htmlFile = new HtmlFile("./src/templates/sample.hbs", invoiceOptions);
      const html: any = await htmlFile.generate();
      return html;


      I also want suggestions on what variable names should I use in place of htmlFile and html.



      Thanks in advance










      share|improve this question







      New contributor




      Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.







      $endgroup$




      I have a class called HtmlFile which has a method called generate. The generate() method is responsible for generating an html file from handlebars template and data object provided in HtmlFile class's constructor.



      I am confused on what code design should I use for this use case and what variable names to choose.



      class HtmlFile {
      public file: any = null;
      private template: any = null;
      private data: any = null;
      constructor(templatePath: string, params: any) {
      this.template = path.resolve(templatePath);
      this.data = params;
      }

      public async generate() {
      try {
      const error = this._validate();
      if (error) {
      throw error;
      }
      const fileContent = fs.readFileSync(this.template, "utf8");
      const html = handlebars.compile(fileContent)(this.data);
      return html;
      } catch (e) {
      throw e;
      }
      }

      private _validate() {
      let errStr: any = null;
      if (typeof this.template !== "string") {
      errStr = `expected template path to be a string, instead got
      ${typeof this.template}`;
      }
      if (typeof this.data !== "object") {
      errStr = `expected data to be an object, instead got ${typeof
      this.data}`;
      }
      return errStr;
      }
      }


      And I am using this class in the following manner



      let htmlFile = new HtmlFile("./src/templates/sample.hbs", invoiceOptions);
      const html: any = await htmlFile.generate();
      return html;


      I also want suggestions on what variable names should I use in place of htmlFile and html.



      Thanks in advance







      javascript object-oriented






      share|improve this question







      New contributor




      Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.











      share|improve this question







      New contributor




      Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      share|improve this question




      share|improve this question






      New contributor




      Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      asked 11 mins ago









      Amir SaleemAmir Saleem

      1




      1




      New contributor




      Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.





      New contributor





      Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






      Amir Saleem is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






















          0






          active

          oldest

          votes











          Your Answer





          StackExchange.ifUsing("editor", function () {
          return StackExchange.using("mathjaxEditing", function () {
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          });
          });
          }, "mathjax-editing");

          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "196"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });






          Amir Saleem is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f214627%2fgenerate-html-file-from-handlebars-template-and-data-object%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          0






          active

          oldest

          votes








          0






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes








          Amir Saleem is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          Amir Saleem is a new contributor. Be nice, and check out our Code of Conduct.













          Amir Saleem is a new contributor. Be nice, and check out our Code of Conduct.












          Amir Saleem is a new contributor. Be nice, and check out our Code of Conduct.
















          Thanks for contributing an answer to Code Review Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          Use MathJax to format equations. MathJax reference.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f214627%2fgenerate-html-file-from-handlebars-template-and-data-object%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Сан-Квентин

          8-я гвардейская общевойсковая армия

          Алькесар