Pdflayer

Any-Promise oriented Wrapper for pdflayer API

Installing

npm install pdflayer

Usage

 
// Example with Express and Bluebird as promise library.
 
require('any-promise/register/bluebird'); //Registering Bluebird as my preferred Promise library. If not done will go native.
 
const PdfLayer = require('pdflayer');
const pdfLayer = new PdfLayer({
    access_key: process.env.PDFLAYER_KEY,
    test: 1,
    rate_limit: 2
});
const express = require('express');
const app = express();
// 
app.get('/raw-html.pdf', function(req, res) {
    // This will generate a responsed promise, with a stream you can pipe out.
    pdfLayer.generate('<div>This Is A Raw Html... and Hello World!</div>', {
        page_size: 'A3' //This is an option object. Follow https://pdflayer.com/documentation for more infos.
    }).then(function(pdfResponse) {
        // You can stream the response to an html res object like this;
        pdfResponse.stream.pipe(res);
        // you find other infos in response like pdfResponse.url (you can redirect to this, but it would be more efficient to use the following 'getUrl' sync function), pdfResponse.headers, pdfResponse.fileName, pdfResponse.size
    }).catch(function(err) {
        console.log('Something gone very wrong: ' + err.message);
    });
});
 
app.get('/url-link.pdf', function(req, res) {
    try{
        // You can also redirect to the response url if you didn't passed some POST specific params (like raw html, header_html and footer_html). SYNC operation. Attention: will espose your raw PDFLayer url.
        res.redirect(pdfLayer.getUrl('https://github.com/giano/pdflayer/blob/master/README.md'));
    }catch(err){
        console.log('Something gone very wrong: ' + err.message);
    }
});
 
app.listen(3000);

Allowed Options

Follow PdfLayer APID Documentation for a list of options.

The options you can pass in 'generate' calls are defined in const DEFAULT_REQUEST_KEYS. They mirrors PdfLayer guideline at the moment of writing.

The "main config options" (the ones you pass when you create an instance of the library) are:

 
{
    "api_url": "http://api.pdflayer.com/api/convert",
    "method": "POST",
    "access_key": "YOUR API KEY"
}

in addition to the DEFAULT_REQUEST_KEYS list.

Set the api_url to 'https://api.pdflayer.com/api/convert' if you want encription and you have a paid plan.

If pdflayer response with an error the Promise will be rejected with the error code, name and message returned from the API.

See a list of possible error responses on PdfLayer API Documentation Error Codes Section.

Yada Yada Words

This is NOT the official pdflayer API Node.js Library!

I just wrote it for one of my projects as it was missing.

I will improve and debug it but, as the ISC license proclaim, this software is provided "as is". Consider it in "beta" at the moment.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Stefano Valicchia - Initial work - giano

See also the list of contributors who participated in this project.

License

This project is licensed under the ISC License - see the LICENSE.md file for details