# wkhtmltopdf-nodejs-options-wrapper

> Wkhtmltopdf options wrapper for node js

Latest version **1.0.7** (published 2015-09-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install wkhtmltopdf-nodejs-options-wrapper
pnpm add wkhtmltopdf-nodejs-options-wrapper
yarn add wkhtmltopdf-nodejs-options-wrapper
bun add wkhtmltopdf-nodejs-options-wrapper
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2015-09-06 |
| First published | 2015-08-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Dmitry Grachikov |
| Maintainers | grizlik1988 |
| Keywords | wkhtmltopdf, nodejs |

## Links

- npm: https://www.npmjs.com/package/wkhtmltopdf-nodejs-options-wrapper
- Repository: https://github.com/GrizliK1988/wkhtmltopdf-nodejs-options-wrapper
- Homepage: https://github.com/GrizliK1988/wkhtmltopdf-nodejs-options-wrapper#readme
- Issues: https://github.com/GrizliK1988/wkhtmltopdf-nodejs-options-wrapper/issues
- npm.io page: https://npm.io/package/wkhtmltopdf-nodejs-options-wrapper

## Dependencies (1)

- [extend](https://npm.io/package/extend.md) ^3.0.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2015-09-06
- 1.0.5 — 2015-09-05
- 1.0.4 — 2015-08-31
- 1.0.3 — 2015-08-31
- 1.0.2 — 2015-08-31

## README

# wkhtmltopdf-nodejs-options-wrapper

A wrapper of wkhtmltopdf options.

# Usage

It can be used in a client for **wkhtmltopdf-nodejs-ws-server** (it has to be started) with webpack like following:

**1. Install from npm:**

- **webpack**,
- **wkhtmltopdf-nodejs-options-wrapper**,
- **socket.io-client**.
    
**2. Create client.js file with contents:**

```
var wkhtmlToPdf = require('wkhtmltopdf-nodejs-options-wrapper'),
    io = require('socket.io-client');

var socket = io('http://192.168.33.125:3000'); //<-address of websocket server.

var page = new wkhtmlToPdf.Page(),
    request = new wkhtmlToPdf.CreateRequest();

//let's generate pdf from google page
page.setInput('http://google.com');

request.setDebug(true); //all debug output will be returned from server
request.addPage(page);
request.getGlobalOptions().setPageSize('Letter'); //default page size is A4

setTimeout(function() {
    socket.emit('create', request.toObject());

    socket.on('pdf:create:success', function(response) {
        console.log('Pdf created: http://192.168.33.125:3000/result_' + response.handle + '.pdf');
        console.log(response);

        // later we can delete pdf: socket.emit('delete', response.handle);
    });

    socket.on('pdf:create:fail', function(response) {
        console.log('Pdf creation failed!');
        console.log(response);
    });
}, 2000);
```

**3. Create webpack.config.js** file with webpack configuration:

```
module.exports = {
    entry: "./client.js",
    output: {
        path: __dirname,
        filename: "compiled.js"
    }
};
```

**4. Compile client.js**

Run **webpack** command from the folder where client.js and webpack.config.js are located. It will create **compiled.js**
file that can be used in html script tag.

**5. Finish**

Include compiled.js script to any html file and open it in any brower.

After steps 1-5 are done pdf with google page will be generated and you will see link to it in js debugger.

# Running tests

To run unit tests you can use **npm test** command.

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