Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nihiue/ilovepdf-node
node.js SDK for iLovePDF REST API(https://developer.ilovepdf.com)
https://github.com/nihiue/ilovepdf-node
ilovepdf node-js sdk
Last synced: 2 months ago
JSON representation
node.js SDK for iLovePDF REST API(https://developer.ilovepdf.com)
- Host: GitHub
- URL: https://github.com/nihiue/ilovepdf-node
- Owner: Nihiue
- Created: 2019-07-26T04:47:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-12T05:47:04.000Z (about 4 years ago)
- Last Synced: 2024-01-14T00:55:21.108Z (about 1 year ago)
- Topics: ilovepdf, node-js, sdk
- Language: JavaScript
- Homepage: https://developer.ilovepdf.com/libraries
- Size: 8.79 KB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-ilovepdf-sdk
node.js SDK for [iLovePDF REST API](https://developer.ilovepdf.com)
[](https://npmjs.org/package/ilovepdf-sdk)
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.
## Install & Register Developer Account
```bash
$ npm install ilovepdf-sdk
```
You can sign up for a iLovePDF account at https://developer.ilovepdf.com
## Quick Start
```javascript
const ilovepdfSDK = require('ilovepdf-sdk');
const sdk = new ilovepdfSDK('PROJECT_PUBLIC_ID','SECRET_KEY');
async function convertOfficeToPdf() {
const task = await sdk.createTask('officepdf');
await task.addFile('./input.docx');
await task.process();
await task.download('./ouput.pdf');
}
```
## More Examples
See demo/index.js.
## API
### new ilovepdfSDK(projectId, secretKey)
Create sdk instance.
### sdk.createTask(taskType)
Create a task.
Task Type List
* merge
* split
* compress
* pdfjpg
* imagepdf
* unlock
* pagenumber
* watermark
* officepdf
* repair
* rotate
* protect
* pdfa
* validatepdfa
* extract
### task.addFile(filePath[,fileOptions])
Add file to current task.
```javascript
await task.addFile('./input.pdf', {
rotate: 0
password: null
});
```
### task.addFileByStream(filename, stream[,fileOptions])
Add file to current task.
```javascript
await task.addFileByStream('input.pdf', myStream, {
rotate: 0
password: null
});
```
### task.process([extraParams])
Start process current task.
About extraParams, see [Process API](https://developer.ilovepdf.com/docs/api-reference#process)
```javascript
await task.process({
metas: {
Title: 'My Document'
},
ignore_errors: true,
// SPECIFIC TOOL PARAMETERS
split_mode: 'ranges'
});
```
### task.download(outputFilePath)
Download result file.
### task.downloadAsStream
Download result file as stream.
## Documentation
Please see https://developer.ilovepdf.com/docs for up-to-date documentation.