@jscad/stl-serializer

STL Serializer for JSCAD

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@jscad/stl-serializer
2,0551022.1.12a month ago5 years agoMinified + gzip package size for @jscad/stl-serializer in KB

Readme

@jscad/stl-serializer
Serializer of JSCAD geometries to STL mesh.

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.

Table of Contents

Installation

npm install @jscad/stl-serializer

Usage

const stlSerializer = require('@jscad/stl-serializer')

const rawData = stlSerializer.serialize({binary: true}, geometry)

//in 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.


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


  • 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)