macOS Node.js PDF library integration

This guide will help you run PDFTron samples and integrate a free trial of the PDFTron SDK into Node.js projects on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

Get the npm package

linkPrerequisites

• Node.js Version: 8, 9, 10, 11, 12, 13, 14

linkInitial setup

Install the npm package:

npm install @pdftron/pdfnet-node

If your OS or Node.js version is not supported, the installation will fail.

linkRun the samples

1. Open a command line console
2. Change the directory to the samples folder
3. Run all samples:

sh runall.sh

You can also enter any individual sample folder to run them separately. For example, here's how to run the AddImageTest sample:

cd AddImageTest
sh RunTest.sh

linkIntegrate into your project

Import the PDFTron SDK by using the following in your Node.js code:

const { PDFNet } = require('@pdftron/pdfnet-node');

At the end of your code, don't forget to call PDFNet.shutdown(), otherwise your Node.js program will keep hanging.

Here is an example for creating a blank pdf page:

const { PDFNet } = require('@pdftron/pdfnet-node');  // you may need to set up NODE_PATH environment variable to make this work.

const main = async() => {
  const doc = await PDFNet.PDFDoc.create();
  const page = await doc.pageCreate();
  doc.pagePushBack(page);
  doc.save('blank.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
};

// add your own license key as the second parameter, e.g. PDFNet.runWithCleanup(main, 'YOUR_LICENSE_KEY')
PDFNet.runWithCleanup(main).catch(function(error) {
  console.log('Error: ' + JSON.stringify(error));
}).then(function(){ PDFNet.shutdown(); });

linkNext step

GuidesAPI docsSamples