convert-svg-to-png

A Node.js module for converting SVG to PNG using headless Chromium.

• Install
• API
• Bugs
• Contributors
• License

Install

Install using npm:

$ npm install --save convert-svg-to-png

You'll need to have at least Node.js 8 or newer.

API

convert(source[, options])

Converts the specified source SVG into a PNG using the options provided via a headless Chromium instance.

source can either be a SVG buffer or string.

If the width and/or height cannot be derived from source then they must be provided via their corresponding options. This method attempts to derive the dimensions from source via any width/height attributes or its calculated viewBox attribute.

An error will occur if source does not contain an SVG element or no width and/or height options were provided and this information could not be derived from source.

Options

Example

const { convert } = require('convert-svg-to-png');
const fs = require('fs');
const path = require('path');
const util = require('util');

const readFile = util.promisify(fs.readFile);
const writeFile = util.promisify(fs.writeFile);

async function convertSvgFile(filePath) {
  const dirPath = path.dirname(filePath);
  const input = await readFile(filePath);
  const output = await convert(input, { baseFile: dirPath });

  await writeFile(path.join(dirPath, `${path.basename(filePath, '.svg')}.png`), output);
}

createConverter()

Creates an instance of Converter.

It is important to note that, after the first time Converter#convert is called, a headless Chromium instance will remain open until Converter#destroy is called. This is done automatically when using the main API convert method, however, when using Converter directly, it is the responsibility of the caller. Due to the fact that creating browser instances is expensive, this level of control allows callers to reuse a browser for multiple conversions. It's not recommended to keep an instance around for too long, as it will use up resources.

Example

const { createConverter } = require('convert-svg-to-png');
const fs = require('fs');
const path = require('path');
const util = require('util');

const readdir = util.promisify(fs.readdir);
const readFile = util.promisify(fs.readFile);
const writeFile = util.promisify(fs.writeFile);

async function convertSvgFiles(dirPath) {
  const converter = createConverter();

  try {
    const filePaths = await readdir(dirPath);

    for (const filePath of filePaths) {
      const extension = path.extname(filePath);
      if (extension !== '.svg') {
        continue;
      }

      const input = await readFile(path.join(dirPath, filePath));
      const output = await converter.convert(input, { baseFile: dirPath });

      await writeFile(path.join(dirPath, `${path.basename(filePath, extension)}.png`), output);
    }
  } finally {
    await converter.destroy();
  }
}

version

The current version of this library.

Example

const { version } = require('convert-svg-to-png');

version;
//=> "0.1.0"

Bugs

If you have any problems with this library or would like to see changes currently in development you can do so here.

Contributors

If you want to contribute, you're a legend! Information on how you can do so can be found in CONTRIBUTING.md. We want your suggestions and pull requests!

A list of all contributors can be found in AUTHORS.md.

License

See LICENSE.md for more information on our MIT license.