point3d - npm Package Compare versions
Comparing version 0.0.3 to 0.0.4
25
index.js
@@ -16,3 +16,4 @@ /** Class representing a point in a 3D Cartesian space */ | ||
| /** Get the x coordinate | ||
| /** Get the x coordinate of the point | ||
| * @readonly | ||
| * @return {number} The x coordinate | ||
@@ -24,3 +25,4 @@ */ | ||
| /** Get the y coordinate | ||
| /** Get the y coordinate of the point | ||
| * @readonly | ||
| * @return {number} The y coordinate | ||
@@ -32,3 +34,4 @@ */ | ||
| /** Get the z coordinate | ||
| /** Get the z coordinate of the point | ||
| * @readonly | ||
| * @return {number} The z coordinate | ||
@@ -42,3 +45,3 @@ */ | ||
| * @param {Point3d} point The point to compare | ||
| * @return {boolean} Whether the two points are equal | ||
| * @return {boolean} | ||
| */ | ||
@@ -51,3 +54,3 @@ equals(point) { | ||
| * @param {Point3d} point The point to add | ||
| * @return {Point3d} The Point3d resulting from the sum | ||
| * @return {Point3d} | ||
| */ | ||
@@ -64,3 +67,3 @@ plus(point) { | ||
| * @param {number} scalar The value to scale by | ||
| * @return {Point3d} The scaled point | ||
| * @return {Point3d} | ||
| */ | ||
@@ -77,3 +80,3 @@ scale(scalar) { | ||
| * @param {Point3d} point The point to subtract | ||
| * @return {Point3d} The Point3d resulting from the subtraction | ||
| * @return {Point3d} | ||
| */ | ||
@@ -85,4 +88,4 @@ minus(point) { | ||
| /** Compute the scalar or dot product with another Point | ||
| * @param {Point3d} point | ||
| * @return {number} The scalar product | ||
| * @param {Point3d} point The point to compute the product with | ||
| * @return {number} | ||
| */ | ||
@@ -94,4 +97,4 @@ dot(point) { | ||
| /** Compute the vector or cross product with another Point | ||
| * @param {Point3d} point | ||
| * @return {Point3d} The cross product | ||
| * @param {Point3d} point The point to compute the product with | ||
| * @return {Point3d} | ||
| */ | ||
@@ -98,0 +101,0 @@ cross(point) { |
| { | ||
| "name": "point3d", | ||
| "version": "0.0.3", | ||
| "version": "0.0.4", | ||
| "description": "Cartesian 3D data type, with basic vector math methods", | ||
@@ -11,3 +11,3 @@ "main": "index.js", | ||
| "scripts": { | ||
| "build-docs": "jsdoc index.js -d docs --readme README.md", | ||
| "build-docs": "jsdoc -c docs/conf.json", | ||
| "lint": "eslint index.js", | ||
@@ -14,0 +14,0 @@ "test": "jasmine", |
@@ -64,3 +64,3 @@ # point3d | ||
| To make sure we don't break anything as we change the code, point3d has a | ||
| test suite (implemented in [jasmine][], which you can run as follows: | ||
| test suite (implemented in [jasmine][]), which you can run as follows: | ||
| ```bash | ||
@@ -72,6 +72,6 @@ npm run test | ||
| [JSDoc syntax](https://jsdoc.app/howto-es2015-classes.html). When you are done, | ||
| be sure to rebuild the docs before committing your code. This can be done via | ||
| another of the NPM scripts, as follows: | ||
| rebuild the docs before committing your code. This can be done via one of | ||
| the NPM scripts, as follows: | ||
| ```bash | ||
| npm run build-docs | ||
| ``` |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Lines of code
- increased by3.49%
89
Worsened metrics
- Total package byte prevSize
- decreased by-0.52%
7119