mirror of
https://github.com/visioncortex/vtracer.git
synced 2026-09-13 15:45:47 -07:00
Chris Tsang
42f94f0d15
nodejs/scripts/publish.mjs builds the wasm (wasm-pack), runs the smoke test, then `npm publish` to a configurable registry (default a local one at http://localhost:4873; override via --registry= or NPM_REGISTRY). Supports --dry-run. Wired as `npm run publish:local`.
vtracer (Node.js)
Raster → vector (SVG) for Node, a WebAssembly build of the
vtracer framework. Image decoding
and vectorization both happen in wasm, so there is no native dependency —
just npm install.
Install
npm install vtracer
Usage
const vtracer = require('vtracer');
// file in, file out
await vtracer.convertFile('in.png', 'out.svg');
await vtracer.convertFile('in.jpg', 'out.svg', { mode: 'polygon', hierarchical: 'cutout' });
// buffers
const svg = vtracer.convertBuffer(fs.readFileSync('in.png'), { preset: 'poster' });
// raw RGBA8 pixels
const svg2 = vtracer.convertPixels(rgba, width, height, { colorMode: 'bw' });
API
convertBuffer(buffer, options?) => string— encoded image (PNG/JPEG/GIF/BMP) → SVG.convertPixels(rgba, width, height, options?) => string— raw RGBA8 → SVG.convertFile(input, output, options?) => Promise<void>— read, trace, write.convertFileSync(input, output, options?) => void.
Options (all optional, camelCase)
preset ("bw" | "poster" | "photo", applied first), colorMode
("color" | "bw"), hierarchical ("stacked" | "cutout" for the seam-free
mosaic), mode ("pixel" | "polygon" | "spline"), filterSpeckle,
colorPrecision, layerDifference, cornerThreshold, lengthThreshold,
maxIterations, spliceThreshold, pathPrecision, palette (list of
#rrggbb), maxColors, optimize (0 | 1 | 2).
Build from source
Requires the Rust toolchain and wasm-pack:
npm run build # wasm-pack build --target nodejs --out-dir pkg
npm test