Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashiknesin/remove-pdf-password
Remove password from your pdf easily 🔓
https://github.com/ashiknesin/remove-pdf-password
Last synced: 5 days ago
JSON representation
Remove password from your pdf easily 🔓
- Host: GitHub
- URL: https://github.com/ashiknesin/remove-pdf-password
- Owner: AshikNesin
- License: mit
- Created: 2018-03-25T13:08:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-03-25T13:15:13.000Z (over 6 years ago)
- Last Synced: 2024-09-19T10:38:09.425Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/remove-pdf-password
- Size: 1.95 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# remove-pdf-password 🔓
> Remove password from your pdf easily
## Install
```
$ npm install --save remove-pdf-password
```## Dependency
This package depends on [qpdf](http://qpdf.sourceforge.net/)
You can install this pretty much easily using the following commands
### MacOS
```sh
brew install qpdf
```### Ubuntu
```sh
sudo apt-get install qpdf
```## Usage
```js
const removePdfPassword = require('remove-pdf-password');const params = {
inputFilePath: '/Users/YourName/input.pdf',
password: "secrect",
outputFilePath: '/Users/YourName/output.pdf',
}removePdfPassword(params);
```
## API
### removePdfPassword(input, [options])
#### inputFilePath
Type: `string`
Local **absolute** path to your input pdf file in which you want to remove password.
#### outputFilePath
Type: `string`
Local **absolute** path to your output pdf file in which the password will be removed.
#### password
Type: `string`
Password for your pdf
## TODO
- [ ] Check if qpdf is installed in machine
- [ ] Read input file from web (http://example.com/file.pdf)
- [ ] Handle and return success/failure state
- [ ] Convert Relative path → absolute path?## License
MIT © [Ashik Nesin](https://ashiknesin.com)