README
npm-complex
NPM Module for operations on the complex plane.
npm-complex is an ES6 library containing elementary operations on the complex plane. Private fields have yet to be introduced into the ECMAScript standard. However, this module makes use of closures in order to properly encapsulate data. (The use of closures may not be necessary in the future, with the potential release of #private fields. Until then, this remains the best approach.)
Usage
npm-complex is currently available in the following manners:
- Github releases
- NPM
Github releases
npm-complex can be downloaded as a release here. Since this module only makes use of development dependencies, each release contains the JavaScript that pertain to this module.
NPM
npm-complex can be downloaded through the Node Package Manager. The following commands can be used to set up npm-complex as a dependency and development dependency, respectively.
# dependency
npm i npm-complex
# devDependency
npm i --save-dev npm-complex
Documentation
Relevant documentation can be found on the Github wiki here.
Contributing/Issues
Given the small scale of this module, contributions are discouraged. However, if any issues present themselves, please post an issue here.
License
npm-complex is an open-sourced project under the MIT license.