# inkscape

> The inkscape utility as a readable/writable stream

Latest version **3.1.1** (published 2020-11-14) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install inkscape
pnpm add inkscape
yarn add inkscape
bun add inkscape
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2020-11-14 |
| First published | 2013-04-29 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 34 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 78 |
| Author | Andreas Lind |
| Maintainers | papandreou |
| Keywords | inkscape, svg, png, image, optimization, stream, filter, read/write, duplex |

## Links

- npm: https://www.npmjs.com/package/inkscape
- Repository: https://github.com/papandreou/node-inkscape
- Homepage: https://github.com/papandreou/node-inkscape#readme
- Issues: https://github.com/papandreou/node-inkscape/issues
- npm.io page: https://npm.io/package/inkscape

## Dependencies (3)

- [async](https://npm.io/package/async.md) ^3.0.0
- [semver](https://npm.io/package/semver.md) ^7.3.2
- [gettemporaryfilepath](https://npm.io/package/gettemporaryfilepath.md) ^1.0.0

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 3.1.1 (latest) — 2020-11-14
- 3.1.0 — 2020-11-11
- 3.0.0 — 2020-08-11
- 2.1.0 — 2020-07-22
- 2.0.0 — 2018-10-14
- 1.2.0 — 2017-11-06
- 1.1.1 — 2017-04-27
- 1.1.0 — 2016-12-03
- 1.0.0 — 2016-03-31
- 0.0.5 — 2014-05-28
- 0.0.4 — 2014-03-24
- 0.0.3 — 2013-09-19
- 0.0.2 — 2013-06-03
- 0.0.1 — 2013-04-29

## README

# node-inkscape

[![NPM version](https://badge.fury.io/js/inkscape.svg)](http://badge.fury.io/js/inkscape)
[![Build Status](https://travis-ci.org/papandreou/node-inkscape.svg?branch=master)](https://travis-ci.org/papandreou/node-inkscape)
[![Coverage Status](https://coveralls.io/repos/papandreou/node-inkscape/badge.svg)](https://coveralls.io/r/papandreou/node-inkscape)
[![Dependency Status](https://david-dm.org/papandreou/node-inkscape.svg)](https://david-dm.org/papandreou/node-inkscape)

The inkscape command line utility as a readable/writable stream. This
is handy for situations where you don't want to worry about writing
the input to disc and reading the output afterwards.

The constructor optionally takes an array of command line options for
the `inkscape` binary:

```javascript
var Inkscape = require('inkscape'),
  svgToPdfConverter = new Inkscape(['--export-pdf', '--export-width=1024']);

sourceStream.pipe(svgToPdfConverter).pipe(destinationStream);
```

Import type can also be fed to the constructor (converting PDF to PNG):

```javascript
var Inkscape = require('inkscape'),
  pdfToPngConverter = new Inkscape([
    '--export-png',
    '--export-width=1024',
    '--import-pdf',
  ]);

sourceStream.pipe(pdfToPngConverter).pipe(destinationStream);
```

Inkscape as a web service (converts to a PNG):

```javascript
var Inkscape = require('inkscape'),
  http = require('http');

http
  .createServer(function (req, res) {
    if (req.headers['content-type'] === 'image/svg') {
      res.writeHead(200, { 'Content-Type': 'image/png' });
      req.pipe(new Inkscape(['-e'])).pipe(res);
    } else {
      res.writeHead(400);
      res.end('Feed me an SVG!');
    }
  })
  .listen(1337);
```

## Installation

Make sure you have node.js and npm installed, and that the `inkscape` binary is in your PATH, then run:

    npm install inkscape

## License

3-clause BSD license -- see the `LICENSE` file for details.

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