Nos-PDF

Authored by IBI Data

Usage

The PDF module can be used with callbacks or promises. No special setup required.

Callbacks

app.get(`${config.site.url}/example.pdf`, (req, res, next) => {

    let pdf = require('nos-pdf');

    let options = {
        src: './path/to/pdf/template.pdf',
        data: {
            customernm: 'john',
            email: '[email protected]'
        },
        flatten: true
    };

    pdf.fillForm(options, (err, file) {
        if (err) return next(err);
        res.type('application/pdf'); // IF YOU WANT TO SEND THE FILE TO THE BROWSER. OMIT THIS IF YOU WANT IT TO DOWNLOAD.
        res.send(file);
    });

});

Promises

app.get(`${config.site.url}/example.pdf`, (req, res, next) => {

    let pdf = require('nos-pdf');

    let options = {
        src: './path/to/pdf/template.pdf',
        data: {
            customernm: 'john',
            email: '[email protected]'
        },
        flatten: true
    };

    pdf.fillForm(options)

    .then(file => {
        res.type('application/pdf'); // IF YOU WANT TO SEND THE FILE TO THE BROWSER. OMIT THIS IF YOU WANT IT TO DOWNLOAD.
        res.send(file);
    })

    .catch(err => {
        return next(err);
    });

});

Methods

• fillForm

Fills PDF forms

- *Arguments*
    - options <Object>
        - src <String> (null) - The path to your PDF template.
        - dest <String> (null) - Destination path of newly created PDF. If omitted, file will only be sent to browser, not saved.
        - data <Object> (null) - JSON object with data to fill PDF form.
        - flatten <Boolean> (true) - Flatten PDF. This makes it uneditable. If you select false, it will be editable in the browser.

• stamp

Stamp one PDF onto another.

- *Arguments*
    - options <Object>
        - src <String> (null) - The path to your PDF to be stamped.
        - stampFile <String> (null) - The path to your PDF that you wish to stamp on the src (works best as transparent).
        - data <Object> (null) - JSON object with data to fill PDF form.
        - flatten <Boolean> (true) - Flatten PDF. This makes it uneditable. If you select false, it will be editable in the browser.

• generateXfdf

Transform JSON object into XFDF file.

- *Arguments*
    - data <Object> - JSON object you wish to convert to Xfdf file.