express-dom-pdf
Advanced tools
PDF plugin for express-dom
Optionally converts pdf using ghostscript with presets.
See express-dom documentation about how web pages are prerendered.
const dom = require('express-dom');
const pdf = require('express-dom-pdf');
const express = require('express');
const app = express();
// unconditionally outputs a pdf
app.get('*.html', dom(pdf({
presets: {
// merged with pdf.presets
},
policies: {
// merged with pdf.policies
}
plugins: ['custom'] // these plugins are added before 'pdf' plugin
})).route((phase, req, res) => {
if (phase.visible) {
phase.settings.pdf(req.query.pdf);
// no need to keep the parameter during prerendering
phase.location.searchParams.delete('pdf');
} else {
res.set('Content-Security-Policy', "default 'self' data:");
}
}), express.static('public/'));
It is also possible to get a response stream directly without express, in scenarios where pdf generation takes a long time:
// res: { statusCode, headers } is a passthrough stream
const res = dom(pdf(opts))({
url: 'http://localhost/custom.html',
body: '<html>...</html>'
});
Depends on the value of the phase.settings.preset parameter.
If not set, the "default" preset is used.
If a preset is unknown, an error with error.statusCode of 400 is thrown.
Ghostscript can produce a pdf/x-3 using this kind of preset:
pdf.presets.fogra39l = {
quality: 'printer',
devicePixelRatio: 4,
pdfx: true,
icc: 'ISOcoated_v2_300_eci.icc',
condition: 'FOGRA39L',
others: [ "-dColorImageResolution=600" ]
};
See also pdflib documentation.
For pdf/a-2 output, a icc profile may be specified.
These settings can be changed globally, or for each instance.
icc-profiles to get some common profiles in /usr/share/color/icc)Presets accept these options:
ghostscript/default_cmyk.iccA minimal stylesheet:
@media only print {
@page {
size: 210mm 297mm;
margin:1cm;
}
html, body {
padding: 0;
margin: 0;
}
body > .page {
page-break-inside: avoid;
page-break-after: always;
}
}
Sample code of how to break pages at the DOM level, before printing, is available in test/public/autobreak.html (to actually see the result, just serve test/public and open autobreak.html).
This is more powerful than print breaks, because it allows one to style the resulting layout.
On Debian, install fonts-recommended package.
System fonts rendering can have some bugs, especially regarding emojis or color fonts.
FAQs
PDF plugin for express-dom
We found that express-dom-pdf demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket identified 80 fake candidates targeting engineering roles, including suspected North Korean operators, exposing the new reality of hiring as a security function.
Application Security
/Research
/Security News
Socket detected multiple compromised CrowdStrike npm packages, continuing the "Shai-Hulud" supply chain attack that has now impacted nearly 500 packages.
Research
/Security News
Malicious update to @ctrl/tinycolor on npm is part of a supply-chain attack hitting 40+ packages across maintainers