js-geometry-2d v2.1.1

js-geometry-2d

Overview

js-geometry-2d is a simple JavaScript library that contains basic geometry operations (e.g. scalar product, rotation) and primitives (e.g. point, circle, rectangle).

Installation

npm i -D js-geometry-2d

Usage

Commands

npm run test runs ESLint check for ./src directory

npm run docs outputs JsDoc documentation to ./docs directory

Import

Don’t forget to require module:

const Geometry2D = require('js-geometry-2d');
const operations = Geometry2D.operations;
const primitives = Geometry2D.primitives;

Use library’s functions and classes like this:

let scalar = operations.scalarProduct(3, 5, 1, 0);
let circle = new primitives.Circle(0, 0, 5);

Documentation

All functions and classes descriptions and examples can be found in Wiki.

Or just run npm run docs to generate it to ./docs.