npm

Don't miss out on this year's npm Pride t-shirt designs!Order your favorites here »

easypdfcloud-node

1.0.0 • Public • Published

easypdfcloud-node

Version License

A Node library for easyPDF Cloud API https://www.easypdfcloud.com/developer/reference

The easyPDF Cloud API is a cloud-based platform that allows PDF generation, conversion and automation.

This easy-to-use tool eliminates the need for separate APIs for different file formats and works with Word, Excel, PowerPoint, HTML, and images.

To get started, sign up for free and then get your API access credentials from the developer information page.

For detailed information about the easyPDF Cloud API, visit the API reference page.

Installation

npm install easypdfcloud-node

Usage

Using pre-created workflow (workflow ID)

You can create a workflow by connecting series of workflow tasks with mouse drag & drop from easyPDF Cloud website. After creating a new workflow, you can get its workflow ID from the developer information page, and then pass it to the API.

"use strict";
 
const fs = require('fs');
const easyPdfCloud = require('easypdfcloud-node');
 
(async () => {
    // Create easyPDF Cloud client object
    const client = new easyPdfCloud.Client('<client ID>', '<client secret>');
 
    // Upload input file and start new job
    const job = await client.startNewJob('<workflow ID>', '/Users/someone/input.docx');
 
    // Wait until job execution is completed
    const result = await job.waitForJobExecutionCompletion();
 
    // Save output to file
    fs.writeFileSync('/Users/someone/output.pdf', result.fileData.blob, 'binary');
})();

Using dynamically created workflow

Alternatively, you can create a workflow on the spot and pass it to the API.

Following example creates a workflow that adds a watermark to a PDF.

"use strict";
 
const fs = require('fs');
const easyPdfCloud = require('easypdfcloud-node');
 
(async () => {
    // Create easyPDF Cloud client object
    const client = new easyPdfCloud.Client('<client ID>', '<client secret>');
 
    // Dynamically create workflow
    const workflowSetting = new easyPdfCloud.WorkflowSetting();
 
    // Add "Add watermark" task
    const addWatermarkToPdfTask = workflowSetting.AddNewAddWatermarkToPdfTask();
 
    // Configure watermark settings
    addWatermarkToPdfTask.Angle = 45;
    addWatermarkToPdfTask.OutlineOnly = true;
    addWatermarkToPdfTask.Text = 'Hello';
 
    // Upload input file and start new job
    const job = await client.startNewJob(workflowSetting, '/Users/someone/input.pdf');
 
    // Wait until job execution is completed
    const result = await job.waitForJobExecutionCompletion();
 
    // Save output to file
    fs.writeFileSync('/Users/someone/output.pdf', result.fileData.blob, 'binary');
})();

TypeScript support

This library supports TypeScript too (.d.ts declaration files are included in this package).

"use strict";
 
import * as fs from 'fs';
import * as easyPdfCloud from 'easypdfcloud-node';
 
(async () => {
    // Create easyPDF Cloud client object
    const client = new easyPdfCloud.Client('<client ID>', '<client secret>');
 
    // Dynamically create workflow
    const workflowSetting = new easyPdfCloud.WorkflowSetting();
 
    // Add "Convert PDF to Word" task
    const convertPdfToWordTask = workflowSetting.AddNewConvertPdfToWordTask();
 
    // Upload input file and start new job
    const job = await client.startNewJob(workflowSetting, '/Users/someone/input.pdf');
 
    // Wait until job execution is completed
    const result = await job.waitForJobExecutionCompletion();
 
    // Save output to file
    fs.writeFileSync('/Users/someone/output.docx', result.fileData.blob, 'binary');
})();

install

npm i easypdfcloud-node

Downloadsweekly downloads

70

version

1.0.0

license

MIT

last publish

collaborators

  • avatar
Report a vulnerability