vec2-fn

What's this?

This is a small JS library containing some utility functions for working with vector 2 (like) objects an arrays. The functions are sometimes not pure in the sense that they will modify the vector you provide to them. This allows the reuse of vector object instances and compatibility between different vector class types.

Install

npm i -S vec2-fn

API Docs

API docs can be found here

ES usage:

// Import star
import * as vec2 from "vec2-fn";
vec2.equal({ x: 0, y: 0 }, vec2.ZERO);

// Import named
import { equal, ZERO } from "vec2-fn";
equal({ x: 0, y: 0 }, ZERO);

Node usage:

// Import all
const vec2 = require("vec2-fn");
vec2.equal({ x: 0, y: 0 }, vec2.ZERO);

// Assign named
const { equal, ZERO } = require("vec2-fn");
equal({ x: 0, y: 0 }, ZERO);

Static usage:

Old school method

<script src="./bin/vec2.js"></script>
<script>
    vec2.equal({ x: 0, y: 0 }, vec2.ZERO);
</script>

For static usage, ambient type definitions can optionally be referenced here node_modules/vec2-fn/bin/vec2.d.ts.