# canvas-to-dom-assets-generator

> Helper package for generating assets for canvas-to-dom in node

Latest version **1.0.0** (published 2020-07-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install canvas-to-dom-assets-generator
pnpm add canvas-to-dom-assets-generator
yarn add canvas-to-dom-assets-generator
bun add canvas-to-dom-assets-generator
```

## 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.0 |
| Published | 2020-07-19 |
| First published | 2020-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ardnaxela |
| Maintainers | ardnaxela |

## Links

- npm: https://www.npmjs.com/package/canvas-to-dom-assets-generator
- Repository: https://github.com/alexardra/canvas-to-dom
- Homepage: https://github.com/alexardra/canvas-to-dom/libs/assets-generator/#readme
- Issues: https://github.com/alexardra/canvas-to-dom/issues
- npm.io page: https://npm.io/package/canvas-to-dom-assets-generator

## Dependencies (2)

- [timesnap](https://npm.io/package/timesnap.md) ^0.1.2
- [puppeteer](https://npm.io/package/puppeteer.md) ^5.2.0

## Recent versions

- 1.0.0 (latest) — 2020-07-19

## README

# canvas-to-dom-assets-generator 

Helper package for generating assets for [canvas-to-dom](https://github.com/alexardra/canvas-to-dom) in node.


## Installation

```shell
$ npm install --save canvas-to-dom-assets-generator
```

## Quick start

```javascript
const assetsGenerator = require("canvas-to-dom-assets-generator");

assetsGenerator({
    "url": "http://localhost:3000",
    "selector": "canvas",
    "frame": "1",
    "outputDir": "/home/user/Desktop/"
})
```
**Use with cli**
```javascript
assetsGenerator()
```
or
```javascript
assetsGenerator({
    "cli": true
})
```
```bash
node example.js url=http://localhost:3000 frame=1 outputDir=/home/user/Desktop/
```

## Examples

**Use canvas id selector**
```javascript
assetsGenerator({
    "url": "http://localhost:3000",
    "selectorId": "app",
    "frame": "1",
    "outputDir": "/home/user/Desktop/",
    "outputFrameName": "frame1.png"
})
```
**Use canvas class selector**
```javascript
assetsGenerator({
    "url": "http://localhost:3000",
    "selectorCls": "app",
    "frame": "1",
    "outputDir": "/home/user/Desktop/"
})
```
**Use with default options**
```javascript
assetsGenerator({
    "url": "http://localhost:3000"
})
```
Default options:
* selector: **canvas**
* frame: **0**
* outputFrameName: **screenshot.png**
* outputDir: **current directory**

---
_Source: https://npm.io/package/canvas-to-dom-assets-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._