Create a PDF file from any web page
$ npm install --save @magneds/hapi-plugin-pdf
As the name might have suggested already, this package is a plugin for the Hapi framework, simply registering the package as plugin will suffice.
const HapiServer = require('@magneds/node-hapi-server');
const HapiPluginPDF = require('@magneds/hapi-plugin-pdf');
new HapiServer()
.configure({ host: 'localhost', port: 3000 })
.plugin(HapiPluginPDF)
.start()
.then(() => console.log(`Running @${server.info.uri}`));
const Hapi = require('hapi');
const HapiPluginPDF = require('@magneds/hapi-plugin-pdf');
const server = Hapi.server({ host: 'localhost', port: 3000 });
const init = async () => {
await server.register(HapiPluginPDF);
await server.start();
console.log(`Running @${server.info.uri}`);
};
init();
The pdf plugins registers two routes. The /pdf/render
works with both the GET
and POST
request methods, the pdf/render/content
works only with a POST
request.
The request is delegated to the provided url using the method used to call the /pdf/render
endpoint, any GET and/or POST parameter as well as all headers are added to the delegated request.
A GET request only requires a (properly encoded) url
parameter, which contains the url to the web page to render as PDF.
Any header provided will be provided to the final destination.
Like the GET request, a POST request also only requires the url
parameter, which may be provided in either the payload (body) or as parameter to the url.
All headers and payload data will be provided to the final destination.
A POST request only requires the content
parameter, which may should be provided in the payload (body).
The '/pdf' portion of the route is a so-called route prefix, it can be changed to whatever you'd like during registration to Hapi by specifying an alternative.
//...
// rename the /pdf/render path to /my-custom/pdf/render
.plugin({ ...HapiPluginPDF, routes: { prefix: '/my-custom/pdf' } })
//..
//...
// rename the /pdf/render path to /my-custom/pdf/render
await server.register({ ...HapiPluginPDF, routes: { prefix: '/my-custom/pdf' } });
//...
};
init();
Please see Changelog
$ npm test
Please see Contributing
The MIT License (MIT). Please see License File for more information.