@jscad/svg-serializer

SVG Serializer for JSCAD

Stats

StarsIssuesVersionUpdatedCreatedSize
@jscad/svg-serializer
1,7751262.2.613 days ago4 years agoMinified + gzip package size for @jscad/svg-serializer in KB

Readme

@jscad/svg-serializer

Serializer of JSCAD geometries to SVG commands

NPM version NPM downloads Build Status Stability License

User Group Lerna JavaScript Style Guide

Backers Sponsors

Open Collective

Overview

This serializer outputs a 'blobable' array of data from one or more JSCAD geometries. The array of data can either be used to create a Blob (new Blob(blobable)), or converted to a Node.js buffer.

The serialization of the following geometries are possible.

  • serialization of 2D geometry (geom2) to continous SVG paths
  • serialization of 2D paths (path2) to individual SVG paths

Table of Contents

Installation

npm install @jscad/svg-serializer

Usage

const svgSerializer = require('@jscad/svg-serializer')

const rawData = svgSerializer.serialize({unit: 'cm'}, object)

// within a browser (with browserify etc)
const blob = new Blob(rawData)

Contributing

The various JSCAD packages and all source code are part of the JSCAD Organization, and maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.

  • If you want to submit a bug report please make sure to follow the Reporting Issues guide. Bug reports are accepted as Issues via GitHub.

  • If you want to submit a change or a patch, please read the Contributing Guide. New contributions are accepted as Pull Requests via GithHub.

  • We only accept bug reports and pull requests on GitHub.

  • If you have a question about how to use JSCAD, then please start a conversation at the JSCAD User Group. You might find the answer in the JSCAD User Guide.

  • If you have a change or new feature in mind, please start a conversation with the Core Developers and start contributing changes.

Small Note: If editing this README, please conform to the standard-readme specification.

License

The MIT License (MIT) (unless specified otherwise)

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.