@jscad/io

Meta Package for JSCAD IO Packages

Stats

StarsIssuesVersionUpdatedCreatedSize
@jscad/io
1,7751262.0.716 days ago4 years agoMinified + gzip package size for @jscad/io in KB

Readme

@jscad/io

Input/Output format handling for the JSCAD project.

NPM version NPM downloads Build Status Stability License

User Group Lerna JavaScript Style Guide

Backers Sponsors

Open Collective

Overview

This package is a metapackage and includes all the input/output format handling for the JSCAD projects, and can also be used separately.

Inputs / Deserializers

ie: file data => JSCAD code or JSCAD geometry

Following formats are supported as inputs

Outputs/ Serializers

ie: geometry => blob

Following formats are supported as outputs

Table of Contents

Installation

npm install @jscad/io

Usage

  • as Node module :
const io = require('@jscad/io')

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.