npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

svg2png

v4.1.1

Published

Converts SVGs to PNGs, using PhantomJS

Downloads

68,280

Readme

SVG-to-PNG Converter Using PhantomJS

You have a SVG file. For whatever reason, you need a PNG. svg2png can help.

const fs = require("pn/fs"); // https://www.npmjs.com/package/pn
const svg2png = require("svg2png");

fs.readFile("source.svg")
    .then(svg2png)
    .then(buffer => fs.writeFile("dest.png", buffer))
    .catch(e => console.error(e));

In the above example, we use the width and height attributes specified in the SVG file to automatically determine the size of the SVG. You can also explicitly set the size:

svg2png(sourceBuffer, { width: 300, height: 400 })
    .then(buffer => ...)
    .catch(e => console.error(e));

This is especially useful for images without width or heights. You can even specify just one of them and (if the image has an appropriate viewBox) the other will be set to scale.

Finally, some SVG files reference external resources using relative paths. You can set them up for correct conversion by passing the filename or url option:

svg2png(sourceBuffer, { url: "https://example.com/awesomeness.svg" })
    .then(buffer => ...)
    .catch(e => console.error(e));

svg2png(sourceBuffer, { filename: path.resolve(__dirname, "images/fun.svg") })
    .then(buffer => ...)
    .catch(e => console.error(e));

Sync variant

There's also a sync variant, for use in your shell scripts:

const outputBuffer = svg2png.sync(sourceBuffer, options);

How the conversion is done

svg2png is built on the latest in PhantomJS technology to render your SVGs using a headless WebKit instance. I have found this to produce much more accurate renderings than other solutions like GraphicsMagick or Inkscape. Plus, it's easy to install cross-platform due to the excellent phantomjs npm package—you don't even need to have PhantomJS in your PATH.

Rendering isn't perfect; we have a number of issues that are blocked on PhantomJS getting its act together and releasing a cross-platform version with updated WebKit.

Exact resizing behavior

Previous versions of svg2png attempted to infer a good size based on the width, height, and viewBox attributes. As of our 3.0 release, we attempt to stick as close to the behavior of loading a SVG file in your browser as possible. The rules are:

  • Any width or height attributes that are in percentages are ignored and do not count for the subsequent rules.
  • The dimensions option { width, height } overrides any width or height attributes in the SVG file, including for the subsequent rules. If a key is missing from the dimensions object (i.e. { width } or { height }) the corresponding attribute in the SVG file will be deleted.
  • width and height attributes without a viewBox attribute cause the output to be of those dimensions; this might crop the image or expand it with empty space to the bottom and to the right.
  • width and/or height attributes with a viewBox attribute cause the image to scale to those dimensions. If the ratio does not match the viewBox's aspect ratio, the image will be expanded and centered with empty space in the extra dimensions. When a viewBox is present, one of either width or height can be omitted, with the missing one inferred from the viewBox's aspect ratio.
  • When there are neither width nor height attributes, the promise rejects.

One thing to note is that svg2png does not and cannot stretch your images to new aspect ratios.

CLI

This package comes with a CLI version as well; you can install it globally with npm install svg2png -g. Use it as follows:

$ svg2png --help
Converts SVGs to PNGs, using PhantomJS

svg2png input.svg [--output=output.png] [--width=300] [--height=150]

Options:
  -o, --output  The output filename; if not provided, will be inferred  [string]
  -w, --width   The output file width, in pixels                        [string]
  -h, --height  The output file height, in pixels                       [string]
  --help        Show help                                              [boolean]
  --version     Show version number                                    [boolean]

Node.js requirements

svg2png uses the latest in ES2015 features, and as such requires a recent version of Node.js. Only the 6.x series onward is supported.