# pdf-pipe

> module that takes a url and using pdfcrowd pipes the resulting pdf into an s3 bucket

Latest version **1.0.0** (published 2017-01-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install pdf-pipe
pnpm add pdf-pipe
yarn add pdf-pipe
bun add pdf-pipe
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: no vulnerabilities; popular repo.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-01-26 |
| First published | 2017-01-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 17617 |
| Author | jordan l piepkow |
| Maintainers | jpiepkow |
| Keywords | pdf, pipe, pdfcrowd, stream |

## Links

- npm: https://www.npmjs.com/package/pdf-pipe
- Repository: https://github.com/npm/npm
- Homepage: https://github.com/npm/npm#readme
- Issues: https://github.com/npm/npm/issues
- npm.io page: https://npm.io/package/pdf-pipe

## Dependencies (3)

- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.8.0
- [pdfcrowd](https://npm.io/package/pdfcrowd.md) ^1.1.1
- [s3-upload-stream](https://npm.io/package/s3-upload-stream.md) ^1.0.7

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-01-26

## README

pdf-pipe
=======
Install & start
	
	npm install pdf-pipe -s	
	
	
	
	let pdfPipe = require('pdfPipe')
	let pdf = new pdfPipe(config //explained below)
	pdf.pipeUrl(url,bucket,name)
		.then(console.log)
		.catch(console.log)
	
	
config for constructor: 

	{
		accessKey:aws access key, //not required
		secretKey:aws secret key, //not required
		region: aws region, // not required defaults to us-east-1
		pdfCrowd: {
			userName: pdfCrowd username,
			apiKey: pdfCrowd api key
		}
	}	
	
	//can have aws keys in env variable as AWS_ACCESS_KEY_ID
	and AWS_SECRET_ACCESS_KEY

**NOTE: aws will use creds in this order passed in to config > in enviroment var > with your system profile**


method:

	pipeUrl(url,bucket,name) //Promise
		args:
			url: url that will be converted to pdf
			bucket: name of bucket to insert item
			name: name of output item(must end in .pdf)
			
		return:
				resolve or reject of promise
				
		example:
		
			pdf.pipeUrl('http://google.com','testBucket','google.pdf')
				.then(console.log)
				.catch(console.log)

---
_Source: https://npm.io/package/pdf-pipe · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._