Narcoleptic Pasta Manufacturer

    @ilovepdf/ilovepdf-js
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.0 • Public • Published

    iLovePDF Api - JS Library

    JavaScript library for iLovePDF Api

    You can sign up for a iLovePDF account at https://developer.ilovepdf.com .

    Develop and automate PDF processing tasks like Compress PDF, Merge PDF, Split PDF, convert Office to PDF, PDF to JPG, Images to PDF, add Page Numbers, Rotate PDF, Unlock PDF, stamp a Watermark and Repair PDF. Each one with several settings to get your desired results.

    Requirements

    Requirements to use this library are:

    1. NPM - Package built with version @6.14.5 .
    2. NodeJS - Package built with version @12.18.2 .

    You cand download them here.

    Install

    You can install the library via NPM. Run the following command:

    npm install @ilovepdf/ilovepdf-js

    Also, if you are working with old browsers that don't have support for Promise objects, we recomend install the dependency promise-polyfill:

    npm install promise-polyfill

    Remember that this package needs to be imported somewhere in your project or this polyfill won't be applied.

    Getting Started

    Using public URLs

    import ILovePDFApi from '@ilovepdf/ilovepdf-js';
    
    const instance = new ILovePDFApi('<PUBLIC_KEY>');
    
    // Public and secret key can be found in your developer panel
    // at https://developer.ilovepdf.com/user/projects .
    const task = instance.newTask('merge');
    
    // Promise-based way to use ILovePDFApi.
    task.start()
    .then(() => {
        return task.upload('<PDF_URL1>');
    })
    .then(() => {
        return task.upload('<PDF_URL2>');
    })
    .then(() => {
        return task.process();
    })
    .then(() => {
        return task.download();
    })
    .then((data) => {
        console.log('DONE');
    });

    Using ILovePDFFile class

    import ILovePDFApi from '@ilovepdf/ilovepdf-js';
    import ILovePDFFile from '@ilovepdf/ilovepdf-js/ILovePDFFile';
    
    const instance = new ILovePDFApi('<PUBLIC_KEY>');
    
    const task = instance.newTask('merge');
    
    task.start()
    .then(() => {
        const inputElement = document.getElementById('file-element') as HTMLInputElement;
        const file = new ILovePDFFile(inputElement.files![0]);
    
        return task.upload(file);
    })
    .then(() => {
        return task.upload('<PDF_URL2>');
    })
    .then(() => {
        return task.process();
    })
    .then(() => {
        return task.download();
    })
    .then((data) => {
        console.log('DONE');
    });

    Use sync calls

    Thanks to be a promise-based API it is possible use the await JavaScript operator in order to call Task methods. Here you have an example:

        let task = instance.newTask('merge');
        task = await task.start();
        task = await task.upload('<PDF_URL1>');
        task = await task.upload('<PDF_URL2>');
        task = await task.process();
    
        const data = await task.download();

    Documentation

    Please see https://developer.ilovepdf.com/docs for up-to-date documentation.

    Install

    npm i @ilovepdf/ilovepdf-js

    DownloadsWeekly Downloads

    5

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    263 kB

    Total Files

    83

    Last publish

    Collaborators

    • ilovepdf