Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@jscad/stl-serializer

jscad12.5kMIT2.1.21

STL Serializer for JSCAD

openjscad, jscad, export, serializer, stl

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.

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

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

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.1.21 (2025-09-20)

Note: Version bump only for package @jscad/stl-serializer

2.1.20 (2024-12-29)

Note: Version bump only for package @jscad/stl-serializer

2.1.19 (2024-11-10)

Note: Version bump only for package @jscad/stl-serializer

2.1.18 (2024-10-06)

Note: Version bump only for package @jscad/stl-serializer

2.1.17 (2024-06-02)

Note: Version bump only for package @jscad/stl-serializer

2.1.16 (2024-02-18)

Note: Version bump only for package @jscad/stl-serializer

2.1.15 (2023-06-27)

Note: Version bump only for package @jscad/stl-serializer

2.1.14 (2023-04-30)

Note: Version bump only for package @jscad/stl-serializer

2.1.13 (2022-11-26)

Note: Version bump only for package @jscad/stl-serializer

2.1.12 (2022-08-21)

Note: Version bump only for package @jscad/stl-serializer

2.1.11 (2022-07-17)

Note: Version bump only for package @jscad/stl-serializer

2.1.10 (2022-06-12)

Note: Version bump only for package @jscad/stl-serializer

2.1.9 (2022-05-15)

Note: Version bump only for package @jscad/stl-serializer

2.1.8 (2022-04-24)

Note: Version bump only for package @jscad/stl-serializer

2.1.7 (2022-04-03)

Note: Version bump only for package @jscad/stl-serializer

2.1.6 (2022-04-03)

Note: Version bump only for package @jscad/stl-serializer

2.1.5 (2022-03-13)

Note: Version bump only for package @jscad/stl-serializer

2.1.4 (2022-03-06)

Note: Version bump only for package @jscad/stl-serializer

2.1.3 (2022-02-19)

Note: Version bump only for package @jscad/stl-serializer

2.1.2 (2021-12-26)

Note: Version bump only for package @jscad/stl-serializer

2.1.1 (2021-12-11)

Note: Version bump only for package @jscad/stl-serializer

2.1.0 (2021-11-07)

Features

2.0.10 (2021-10-17)

Note: Version bump only for package @jscad/stl-serializer

2.0.9 (2021-10-04)

Note: Version bump only for package @jscad/stl-serializer

2.0.8 (2021-09-27)

Note: Version bump only for package @jscad/stl-serializer

2.0.7 (2021-09-09)

Note: Version bump only for package @jscad/stl-serializer

2.0.6 (2021-06-20)

Note: Version bump only for package @jscad/stl-serializer

2.0.5 (2021-06-11)

Note: Version bump only for package @jscad/stl-serializer

2.0.4 (2021-06-01)

Note: Version bump only for package @jscad/stl-serializer

2.0.3 (2021-04-20)

Note: Version bump only for package @jscad/stl-serializer

2.0.2 (2021-04-17)

Bug Fixes

2.0.1 (2021-04-15)

Bug Fixes

2.0.0 (2021-04-12)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.11 (2021-03-07)

Bug Fixes

2.0.0-alpha.10 (2021-02-07)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.9 (2021-01-02)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.8 (2020-12-04)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.7 (2020-11-07)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.6 (2020-10-11)

Bug Fixes

  • all: V2 : several fixes for modeling (#705) (62017a4)

2.0.0-alpha.5 (2020-09-29)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.4 (2020-09-28)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.3 (2020-09-19)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.2 (2020-09-08)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.1 (2020-08-19)

Note: Version bump only for package @jscad/stl-serializer

2.0.0-alpha.0 (2020-08-13)

Bug Fixes

  • stl-serializer: improved progress handling in CSGToStlb.js

Features

  • stl-serializer: updated for V2 (#473)

0.2.0 (2018-11-25)

0.1.3 (2018-09-02)

Bug Fixes

  • svg deserializer: fixed svg-deserializer to work with Inkscape files (#72) (f35ea5e)

0.1.2 (2018-03-15)

Note: Version bump only for package @jscad/stl-serializer

0.1.1 (2017-12-14)

Note: Version bump only for package @jscad/stl-serializer

0.1.0 (2017-11-29)

Features

  • add support for a status callback for de/serialization progress (#49) (f457cdb)

0.0.6 (2017-11-04)

Note: Version bump only for package @jscad/stl-serializer

0.0.5 (2017-10-30)

Note: Version bump only for package @jscad/stl-serializer

0.0.4 (2017-10-10)

Note: Version bump only for package @jscad/stl-serializer

0.0.3 (2017-10-10)

Note: Version bump only for package @jscad/stl-serializer