Node.js API Client Library

Node.js SDK

The PDFCrowd Node.js client library lets server-side JavaScript applications use the conversion APIs. Conversion runs on PDFCrowd's servers. Keep your API key on the server; browser applications should call your backend to request conversions.

Requirements

SDK 7 supports Node.js 18 and later and has no third-party runtime dependencies.

Install with npm

Install the client from npm in your application directory:

npm install pdfcrowd
Other installation methods

Install from a ZIP

Download pdfcrowd-7.0.2-nodejs.zip, extract the archive, and link the package locally:

cd pdfcrowd-7.0.2
npm link

Then, from your application directory:

Install from GitHub

Clone pdfcrowd-nodejs and link its current source locally:

git clone https://github.com/pdfcrowd/pdfcrowd-nodejs
cd pdfcrowd-nodejs
npm link

Then, from your application directory:

Use npm or the ZIP download to install a published release.

TypeScript Dependencies

The SDK's declarations require @types/node version 16 or later, compatible with your TypeScript compiler. If your project does not already provide Node.js types, install them as a development dependency:

npm install --save-dev @types/node

Node.js types are an optional peer dependency and are not installed automatically with pdfcrowd.

Upgrading to SDK 7

In SDK 7, converter client classes return a Promise when you omit a conversion callback or pass undefined. Handle it with await inside try/catch, or with .then() and .catch(). An unhandled rejection can terminate your application. Existing calls with an explicit callback retain callback mode.

The Async/await and Callbacks controls in the SDK guides and Examples pages let you choose either style.

The legacy Pdfcrowd class remains callback-only. Existing callback helpers remain supported.

Using Node.js 16

Node.js 16 may work for conversions that return data or save to a file, but compatibility is not guaranteed. Stream output requires Node.js 18 or later.


Archived Versions