@js-draw/math 1.8.0 → 1.9.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Henry Heino
+Copyright (c) 2023 Henry Heino
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/cjs/Vec3.d.ts

@@ -46,6 +46,15 @@ export declare class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle(): number;
     /**

package/dist/cjs/Vec3.js

@@ -71,6 +71,15 @@ class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle() {
         return Math.atan2(this.y, this.x);

package/dist/mjs/Vec3.d.ts

@@ -46,6 +46,15 @@ export declare class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle(): number;
     /**

package/dist/mjs/Vec3.mjs

@@ -68,6 +68,15 @@ export class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle() {
         return Math.atan2(this.y, this.x);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@js-draw/math",
-	"version": "1.8.0",
+	"version": "1.9.0",
 	"description": "A math library for js-draw. ",
 	"types": "./dist/mjs/lib.d.ts",
 	"main": "./dist/cjs/lib.js",
@@ -19,7 +19,7 @@
 	"license": "MIT",
 	"private": false,
 	"scripts": {
-		"dist-test": "npm run build && cd dist-test/test_imports && npm install && npm run test",
+		"dist-test": "cd dist-test/test_imports && npm install && npm run test",
 		"dist": "npm run build && npm run dist-test",
 		"build": "rm -rf ./dist && mkdir dist && build-tool build",
 		"watch": "rm -rf ./dist/* && mkdir -p dist && build-tool watch"
@@ -45,5 +45,5 @@
 		"svg",
 		"math"
 	],
-	"gitHead": "89f7991833dec5c17ce0890321286198ff7b1900"
+	"gitHead": "e824c37e9f216852cf096976e3a74fb4f177ead3"
 }