typescript-vector v1.0.11

typescript-vector

typescript-vector is a TypeScript package representing vector as independent unit.

Installition

$ npm install typescript-vector

Examples

TypeScript

import { Vector, Vector3D } from 'typescript-vector';

const vector = new Vector(0, 0);
const vector3D = new Vector3D(0, 0, 1);

console.log(vector.isPrimitive());
console.log(vector3D.isPrimitive());

JavaScript

const { Vector, Vector3D } = require('typescript-vector');

const vector = new Vector(0, 0);
const vector3D = new Vector3D(0, 0, 1);

console.log(vector.isPrimitive());
console.log(vector3D.isPrimitive());

Mini-docs

Vector's class methods:

• isPrimitive(): boolean: Check if vector module === 0 or 1.

• size(): number: Return sum od vector's coordinates.

• add(other: Vector2D | number, secondary?: number): Vector2D: Adds up to vectors with similar types.

• sub(other: Vector2D | number, secondary?: number): Vector2D: Subbs up to vectors with similar types.

• mul(other: Vector2D | number, secondary?: number): Vector2D: Mulls up to vectors with similar types.

• div(other: Vector2D | number, secondary?: number): Vector2D: Divs up to vectors with similar types.

• rdiv(other: Vector2D | number, secondary?: number): Vector2D: Roundly divs up to vectors with similar types.

• isEqual(other: Vector2D | number, secondary?: number): boolean: Check for equality vectors with similar types.

• isCollinear(other: Vector2D | number, secondary?: number): boolean: Check if given vector is collinear to first.

Feedback

Open issues and pull requests if it's mandatory. Thanks for reading and downloading.