tea-school-invoice-example.ts

import TeaSchool from 'tea-school';
import * as pug from 'pug';
import * as path from 'path';
import {PDFOptions} from 'puppeteer';
import {Options as SassOptions} from 'node-sass';

(async () => {
  /********************************
   *         STYLE OPTIONS        *
   ********************************/
  const styleOptions: SassOptions = {
    // Get relative path from cwd to the desired file
    file: path.resolve(__dirname, 'invoice-pdf.scss'),
  };

  /********************************
   *      TEMPLATE FILE PATH      *
   ********************************/
  // Get relative path from cwd to the desired file
  const htmlTemplatePath = path.resolve(__dirname, 'invoice-pdf.template.pug');

  /********************************
   *        TEMPLATE OPTIONS      *
   ********************************/
  const htmlTemplateOptions: pug.LocalsObject = {
    invoice: new Invoice(...),
  };

  /********************************
   *        PDF FILE OPTIONS      *
   ********************************/
  const pdfOptions: PDFOptions = {
    // Output path will be relative
    path: path.resolve(__dirname, 'output', 'invoice.pdf'),
    format: 'A4',
  };

  /********************************
   *      PUTTING IT TOGETHER     *
   ********************************/
  const teaSchoolOptions: TeaSchool.GeneratePdfOptions = {
    styleOptions,
    htmlTemplatePath,
    htmlTemplateOptions,
    pdfOptions,
  };

  /**************************************************************
   *      GENERATED PDF AS A BUFFER AND ALSO SAVED TO A FILE      *
   **************************************************************/
  const pdfFile = await TeaSchool.generatePdf(teaSchoolOptions);
})();