@jscad/array-utils

@jscad/array-utils

This package contains utility functions for arrays, which is used throughout the JSCAD project. However, this package can be used independently of the JSCAD project.

Table of Contents

• Usage
• Documentation
• Contribute
• License

Usage

There is no UI or CLi in this package, only pieces of code ready for re-use.

Using with Node.js

This package can be used independently of the JSCAD project.

npm install @jscad/array-utils

And within JavaScript, access the functions.

const { flatten, head, nth, toArray } = require('@jscad/array-utils')

Documentation

See the documentation inside the JavaScript code.

Contribute

This package is part of the JSCAD Organization, and is maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.

Thank you to all the people who have already contributed to this project:

• 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 see the Contributing guidelines. 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 this package, 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)