node-inkscape-promise v0.0.3

node-inkscape

Run inkscape from NodeJS. inkscape installation is required.

Install

# If using as a dependancy in your module
npm install node-inkscape --save

# ...or for use in your project
npm install node-inkscape --save-dev

Prior to using node-inkscape, you must install inkscape.

What’s inkscape?

Inkscape is professional quality vector graphics software which runs on Windows, Mac OS X and Linux. It is used by design professionals and hobbyists worldwide, for creating a wide variety of graphics such as illustrations, icons, logos, diagrams, maps and web graphics. Inkscape uses the W3C open standard SVG (Scalable Vector Graphics) as its native format, and is free and open-source software.

So Then What’s Node-inkscape Do?

Node-inkscape is simply a bridge between the inkscape CLI (command-line interface) and NodeJS.

Usage

Usage

inkscape ( src args options )

Parameters

src

The src can be either the location of a file (./content/file.docx) or a string of textual input ("# Hello, Bananas").

args

The same list of arguments that inkscape accepts on the command line. Arguments are accepted as either a full String or as an Array.

options

The options parameter accepts and passes along a Node ChildProcess.Spawn object and is completely optional. View [a _complete list of inkscape options on the inkscape website](http://inkscape.org/README.html#options) or pull it from the command-line by typing:
$ inkscape -h

Examples of Using node-inkscape

Converting a image.jpg file to a image.png

// In EcmaScript 5...

var nodeinkscape = require('node-inkscape');
var src, args;

src = './image.jpg';

// Arguments can be either a single string:
args = '--export-png=image.png';
// Or in an array of strings -- careful no spaces are present:
args = ['--export-png','image.png'];


// Call inkscape
nodeinkscape(src, args)
.then(res=>{
  console.log(res);  
}).catch(err=>{
    console.error('Oh No: ',err);  
});

// In ES-6 (ES-2015)
import nodeinkscape from 'node-inkscape'

src = './image.jpg';

// Arguments can be either a single string:
args = '--export-png=image.png';
// Or in an array of strings -- careful no spaces are present:
args = ['--export-png','image.png'];


// Call inkscape
await nodeinkscape(src, args);

Converting a image.jpg file to a image.png

var inkscape = require('node-inkscape');

src = './image.jpg';

// Arguments can be either a single string:
args = '--export-png=image.png';
// Or in an array of strings -- careful no spaces are present:
args = ['--export-png','image.png'];

// Call inkscape
await inkscape(src, args);

License

Copyright © Asaf Cohen
Licensed under the MIT License