image-vectorizer/lib/index.js

Potrace in Javascript, for NodeJS and Browser

import Jimp from "jimp"
import Potrace from "./Potrace.js"
import Posterizer from "./Posterizer.js"

/**
 * Wrapper for Potrace that simplifies use down to one function call
 *
 * @param {string|Buffer|Jimp|ImageData} file Source image, file path or {@link ImageData} instance
 * @param {Potrace~Options} [options]
 * @param {traceCallback} cb Callback function. Accepts 3 arguments: error, svg content and instance of {@link Potrace} (so it could be reused with different set of parameters)
 */
function trace(file, options, cb) {
	if (arguments.length === 2) {
		cb = options
		options = {}
	}

	var potrace = new Potrace(options)

	potrace.loadImage(file, function (err) {
		if (err) {
			return cb(err)
		}
		cb(null, potrace.getSVG(), potrace)
	})
}

/**
 * Wrapper for Potrace that simplifies use down to one function call
 *
 * @param {string|Buffer|Jimp|ImageData} file Source image, file path or {@link ImageData} instance
 * @param {Posterizer~Options} [options]
 * @param {posterizeCallback} cb Callback function. Accepts 3 arguments: error, svg content and instance of {@link Potrace} (so it could be reused with different set of parameters)
 */
function posterize(file, options, cb) {
	if (arguments.length === 2) {
		cb = options
		options = {}
	}

	var posterizer = new Posterizer(options)

	posterizer.loadImage(file, function (err) {
		if (err) {
			return cb(err)
		}
		cb(null, posterizer.getSVG(), posterizer)
	})
}

export default {
	trace: trace,
	posterize: posterize,
	Potrace: Potrace,
	Posterizer: Posterizer
}

/**
 * Callback for trace method
 * @callback traceCallback
 * @param {Error|null} err
 * @param {string} svg SVG document contents
 * @param {Potrace} [instance] Potrace class instance
 */

/**
 * Callback for posterize method
 * @callback posterizeCallback
 * @param {Error|null} err
 * @param {string} svg SVG document contents
 * @param {Posterizer} [instance] Posterizer class instance
 */