shapemath.js

A JavaScript Library of math functions for 2D and 3D shapes.

Rewrite in Progress

Version 3.x.x of this package is a rewritten version. I am not currently done, and if you want all of the feautues use the 2.5.0 version until further notice.

Progress

• Circle
• Ellipse
• Kite
• Line
• Oval
• Rectangle
• Rhombus
• Semicircle
• Square
• Trapezoid
• Triangle
• Cone
• Cube
• Cylinder
• Hemisphere
• Rectangular Prism
• Sphere
• Square Pyramid
• Triangular Prism

Install and Usage

npm install shapemath-js

// With import statements.
import { line } from 'shapemath-js';

line.isParallel(0, 1, 2, 2, 0, 2, 2, 3);


// Without import statements.
const shapemath = require('shapemath-js');

shapemath.line.isParallel(0, 1, 2, 2, 0, 2, 2, 3);

Documentation

You can read the documentation at https://shapemath-js.netlify.com/ to learn about all the functions.

Tools Used

• TypeScript: JavaScript Typings
• ESLint: Code Style and Linting
• TSLint: Code Style and Linting
• Jest: Testings
• Coveralls: Coverage
• Travis CI: CI/CD
• TypeDoc: Documentation
• Netlify: Documentation Hosting