@oliversalzburg/js-utils 0.0.18 → 0.0.19-dev.0

package/{lib/math → math}/vector3.js

@@ -17,9 +17,9 @@ export class Vector3 {
     z;
     /**
      * Constructs a new {@linkcode Vector3}.
-     * @param x The X component.
-     * @param y The Y component.
-     * @param z The Z component.
+     * @param x - The X component.
+     * @param y - The Y component.
+     * @param z - The Z component.
      */
     constructor(x = 0, y = 0, z = 0) {
         this.x = x;
@@ -28,7 +28,7 @@ export class Vector3 {
     }
     /**
      * Creates a copy of another {@linkcode Vector3}.
-     * @param vector The vector to copy.
+     * @param vector - The vector to copy.
      * @returns A new vector.
      */
     static fromVector3(vector) {
@@ -36,7 +36,7 @@ export class Vector3 {
     }
     /**
      * Sets the vector to new coordinates.
-     * @param vector The coordinates to set the vector to.
+     * @param vector - The coordinates to set the vector to.
      * @returns This instance.
      */
     set(vector) {
@@ -44,9 +44,9 @@ export class Vector3 {
     }
     /**
      * Sets the vector to new coordinates.
-     * @param x The new X component for the vector.
-     * @param y The new Y component for the vector.
-     * @param z The new Z component for the vector.
+     * @param x - The new X component for the vector.
+     * @param y - The new Y component for the vector.
+     * @param z - The new Z component for the vector.
      * @returns This instance.
      */
     setXYZ(x, y, z) {
@@ -57,7 +57,7 @@ export class Vector3 {
     }
     /**
      * Adds another vector to this vector.
-     * @param vector The vector to add to this vector.
+     * @param vector - The vector to add to this vector.
      * @returns This instance.
      */
     add(vector) {
@@ -65,9 +65,9 @@ export class Vector3 {
     }
     /**
      * Adds another vector to this vector.
-     * @param x The value to add to the X component.
-     * @param y The value to add to the Y component.
-     * @param z The value to add to the Z component.
+     * @param x - The value to add to the X component.
+     * @param y - The value to add to the Y component.
+     * @param z - The value to add to the Z component.
      * @returns This instance.
      */
     addXYZ(x, y, z) {
@@ -78,8 +78,8 @@ export class Vector3 {
     }
     /**
      * Scales another vector and adds it to this vector.
-     * @param vector The vector to add to this vector.
-     * @param scale The scaling to apply to the input vector.
+     * @param vector - The vector to add to this vector.
+     * @param scale - The scaling to apply to the input vector.
      * @returns This instance.
      */
     addMultiply(vector, scale) {
@@ -87,10 +87,10 @@ export class Vector3 {
     }
     /**
      * Scales another vector and adds it to this vector.
-     * @param x The value to add to the X component.
-     * @param y The value to add to the Y component.
-     * @param z The value to add to the Z component.
-     * @param scale The scaling to apply to the input vector.
+     * @param x - The value to add to the X component.
+     * @param y - The value to add to the Y component.
+     * @param z - The value to add to the Z component.
+     * @param scale - The scaling to apply to the input vector.
      * @returns This instance.
      */
     addMultiplyXYZ(x, y, z, scale) {
@@ -101,7 +101,7 @@ export class Vector3 {
     }
     /**
      * Subtracts another vector from this vector.
-     * @param vector The vector to subtract from this vector.
+     * @param vector - The vector to subtract from this vector.
      * @returns This instance.
      */
     subtract(vector) {
@@ -109,9 +109,9 @@ export class Vector3 {
     }
     /**
      * Subtracts another vector from this vector.
-     * @param x The value to subtract from the X component.
-     * @param y The value to subtract from the Y component.
-     * @param z The value to subtract from the Z component.
+     * @param x - The value to subtract from the X component.
+     * @param y - The value to subtract from the Y component.
+     * @param z - The value to subtract from the Z component.
      * @returns This instance.
      */
     subtractXYZ(x, y, z) {
@@ -122,7 +122,7 @@ export class Vector3 {
     }
     /**
      * Multiplies this vector by another vector.
-     * @param vector The vector to multiply with this vector.
+     * @param vector - The vector to multiply with this vector.
      * @returns This instance.
      */
     multiply(vector) {
@@ -130,9 +130,9 @@ export class Vector3 {
     }
     /**
      * Multiplies this vector by another vector.
-     * @param x The value to multiply with the X component.
-     * @param y The value to multiply with the Y component.
-     * @param z The value to multiply with the Z component.
+     * @param x - The value to multiply with the X component.
+     * @param y - The value to multiply with the Y component.
+     * @param z - The value to multiply with the Z component.
      * @returns This instance.
      */
     multiplyXYZ(x, y, z) {
@@ -143,7 +143,7 @@ export class Vector3 {
     }
     /**
      * Multiplies the vector by the given scale.
-     * @param scale The scaling to apply to the vector.
+     * @param scale - The scaling to apply to the vector.
      * @returns This instance.
      */
     multiplyScale(scale) {
@@ -154,7 +154,7 @@ export class Vector3 {
     }
     /**
      * Divides this vector by another vector.
-     * @param vector The vector to divide this vector with.
+     * @param vector - The vector to divide this vector with.
      * @returns This instance.
      */
     divide(vector) {
@@ -162,9 +162,9 @@ export class Vector3 {
     }
     /**
      * Divides this vector by another vector.
-     * @param x The value to divide the X component with.
-     * @param y The value to divide the Y component with.
-     * @param z The value to divide the Z component with.
+     * @param x - The value to divide the X component with.
+     * @param y - The value to divide the Y component with.
+     * @param z - The value to divide the Z component with.
      * @returns This instance.
      */
     divideXYZ(x, y, z) {
@@ -175,7 +175,7 @@ export class Vector3 {
     }
     /**
      * Divides the vector by the given scale.
-     * @param scale The scaling to apply to the vector.
+     * @param scale - The scaling to apply to the vector.
      * @returns This instance.
      */
     divideScale(scale) {
@@ -206,8 +206,8 @@ export class Vector3 {
     }
     /**
      * Clamps the components of the vector at the given boundary.
-     * @param floor The lowest value to allow.
-     * @param ceil The largest value to allow.
+     * @param floor - The lowest value to allow.
+     * @param ceil - The largest value to allow.
      * @returns This instance.
      */
     clamp(floor, ceil) {
@@ -254,7 +254,7 @@ export class Vector3 {
     }
     /**
      * Compares two vectors.
-     * @param vector The vector to compare this vector to.
+     * @param vector - The vector to compare this vector to.
      * @returns `true` if the vectors are idently, `false` otherwise.
      */
     compare(vector) {
@@ -262,8 +262,8 @@ export class Vector3 {
     }
     /**
      * Linearly moves this vector towards a target vector.
-     * @param vector The target vector.
-     * @param t The location on the scale, from `0` to `1`.
+     * @param vector - The target vector.
+     * @param t - The location on the scale, from `0` to `1`.
      * @returns This instance.
      */
     lerp(vector, t) {
@@ -275,7 +275,7 @@ export class Vector3 {
     }
     /**
      * Rotates the vector by the given rotation matrix.
-     * @param matrix The rotation matrix to apply to the vector.
+     * @param matrix - The rotation matrix to apply to the vector.
      * @returns This instance.
      */
     rotate(matrix) {
@@ -289,7 +289,7 @@ export class Vector3 {
     }
     /**
      * Inversely rotates the vector by the given rotation matrix.
-     * @param matrix The rotation matrix to apply to the vector.
+     * @param matrix - The rotation matrix to apply to the vector.
      * @returns This instance.
      */
     rotateInverse(matrix) {
@@ -303,8 +303,8 @@ export class Vector3 {
     }
     /**
      * Rotates the vector by the given rotation matrix around the given center.
-     * @param center The center around which to rotate the vector.
-     * @param matrix The rotation matrix to apply to the vector.
+     * @param center - The center around which to rotate the vector.
+     * @param matrix - The rotation matrix to apply to the vector.
      * @returns This instance.
      */
     rotateAround(center, matrix) {
@@ -318,8 +318,8 @@ export class Vector3 {
     }
     /**
      * Inversely rotates the vector by the given rotation matrix around the given center.
-     * @param center The center around which to rotate the vector.
-     * @param matrix The rotation matrix to apply to the vector.
+     * @param center - The center around which to rotate the vector.
+     * @param matrix - The rotation matrix to apply to the vector.
      * @returns This instance.
      */
     rotateAroundInverse(center, matrix) {
@@ -333,7 +333,7 @@ export class Vector3 {
     }
     /**
      * Transform the vector with a {@linkcode Transformation}.
-     * @param transformation The transformation to apply.
+     * @param transformation - The transformation to apply.
      * @returns This instance.
      */
     transform(transformation) {
@@ -343,7 +343,7 @@ export class Vector3 {
     }
     /**
      * Inversely transform the vector with a {@linkcode Transformation}.
-     * @param transformation The transformation to apply.
+     * @param transformation - The transformation to apply.
      * @returns This instance.
      */
     transformInverse(transformation) {
@@ -353,7 +353,7 @@ export class Vector3 {
     }
     /**
      * Returns the dot product between two vectors.
-     * @param vector The other vector.
+     * @param vector - The other vector.
      * @returns The dot product between the two vectors.
      */
     dot(vector) {
@@ -361,9 +361,9 @@ export class Vector3 {
     }
     /**
      * Returns the dot product between two vectors.
-     * @param x The X component of the other vector.
-     * @param y The Y component of the other vector.
-     * @param z The Z component of the other vector.
+     * @param x - The X component of the other vector.
+     * @param y - The Y component of the other vector.
+     * @param z - The Z component of the other vector.
      * @returns The dot product between the two vectors.
      */
     dotXYZ(x, y, z) {
@@ -372,7 +372,7 @@ export class Vector3 {
     /**
      * Calculates the dot product of this vector and another vector, and then
      * sets this vector to the result.
-     * @param vector The other vector.
+     * @param vector - The other vector.
      * @returns This instance.
      */
     cross(vector) {
@@ -386,9 +386,9 @@ export class Vector3 {
     }
     /**
      * Makes this vector perpendicular to the other 3 vectors.
-     * @param vector0 The first vector.
-     * @param vector1 The second vector.
-     * @param vector2 The third vector.
+     * @param vector0 - The first vector.
+     * @param vector1 - The second vector.
+     * @param vector2 - The third vector.
      * @returns This instance.
      */
     perpendicular(vector0, vector1, vector2) {
@@ -406,7 +406,7 @@ export class Vector3 {
     /**
      * Reflects this vector against the given normal and sets this vector to
      * the result.
-     * @param normal The normal against which to reflect.
+     * @param normal - The normal against which to reflect.
      * @returns This instance.
      */
     reflect(normal) {
@@ -420,8 +420,8 @@ export class Vector3 {
      * Calculates the reflection of this vector, based on the angle of incident
      * into a material with the given refractive index, according to Snell's law.
      * This vector is then set to the result.
-     * @param normal The normal against which to reflect.
-     * @param index The refractive index of the material.
+     * @param normal - The normal against which to reflect.
+     * @param index - The refractive index of the material.
      * @returns This instance.
      */
     fraction(normal, index) {
@@ -445,8 +445,8 @@ export class Vector3 {
 }
 /**
  * Adds two vectors and returns a new vector with the result.
- * @param a The first input vector.
- * @param b The second input vector.
+ * @param a - The first input vector.
+ * @param b - The second input vector.
  * @returns A new {@linkcode Vector3}.
  * @group Math
  */
@@ -455,8 +455,8 @@ export const addVector3 = (a, b) => {
 };
 /**
  * Multiplies two vectors and returns a new vector with the result.
- * @param a The first input vector.
- * @param b The second input vector.
+ * @param a - The first input vector.
+ * @param b - The second input vector.
  * @returns A new {@linkcode Vector3}.
  * @group Math
  */
@@ -465,8 +465,8 @@ export const multiplyVector3 = (a, b) => {
 };
 /**
  * Subtracts two vectors and returns a new vector with the result.
- * @param a The first input vector.
- * @param b The second input vector.
+ * @param a - The first input vector.
+ * @param b - The second input vector.
  * @returns A new {@linkcode Vector3}.
  * @group Math
  */
@@ -475,8 +475,8 @@ export const subtractVector3 = (a, b) => {
 };
 /**
  * Calculates the cross product between two vectors and returns a new vector with the result.
- * @param a The first input vector.
- * @param b The second input vector.
+ * @param a - The first input vector.
+ * @param b - The second input vector.
  * @returns A new vector, which is the cross product of the two input vectors.
  * @group Math
  */
@@ -486,8 +486,8 @@ export const crossVector3 = (a, b) => {
 };
 /**
  * Calculates the dot product between two vectors.
- * @param a The first input vector.
- * @param b The second input vector.
+ * @param a - The first input vector.
+ * @param b - The second input vector.
  * @returns The dot product between the two vectors.
  * @group Math
  */

package/{lib/math → math}/vector4.d.ts

@@ -45,114 +45,114 @@ export declare class Vector4 {
     set w(value: number);
     /**
      * Constructs a new {@linkcode Vector4}.
-     * @param x The X component.
-     * @param y The Y component.
-     * @param z The Z component.
-     * @param w The W component.
+     * @param x - The X component.
+     * @param y - The Y component.
+     * @param z - The Z component.
+     * @param w - The W component.
      */
     constructor(x: number, y: number, z: number, w: number);
     /**
      * Creates a copy of another {@linkcode Vector4}.
-     * @param vector The vector to copy.
+     * @param vector - The vector to copy.
      * @returns A new vector.
      */
     static fromVector4(vector: Readonly<Vector4>): Vector4;
     /**
      * Sets the vector to new coordinates.
-     * @param vector The coordinates to set the vector to.
+     * @param vector - The coordinates to set the vector to.
      * @returns This instance.
      */
     set(vector: Readonly<Vector4>): this;
     /**
      * Sets the vector to new coordinates.
-     * @param x The new X component for the vector.
-     * @param y The new Y component for the vector.
-     * @param z The new Z component for the vector.
-     * @param w The new W component for the vector.
+     * @param x - The new X component for the vector.
+     * @param y - The new Y component for the vector.
+     * @param z - The new Z component for the vector.
+     * @param w - The new W component for the vector.
      * @returns This instance.
      */
     setXYZW(x: number, y: number, z: number, w: number): this;
     /**
      * Adds the XYZ components of another vector to this vector.
-     * @param vector The vector to add to this vector.
+     * @param vector - The vector to add to this vector.
      * @returns This instance.
      */
     add3(vector: Readonly<Vector4>): this;
     /**
      * Adds the XYZ components of another vector to this vector.
-     * @param x The value to add to the X component.
-     * @param y The value to add to the Y component.
-     * @param z The value to add to the Z component.
+     * @param x - The value to add to the X component.
+     * @param y - The value to add to the Y component.
+     * @param z - The value to add to the Z component.
      * @returns This instance.
      */
     add3XYZ(x: number, y: number, z: number): this;
     /**
      * Scales another vector and adds its XYZ components to this vector.
-     * @param vector The vector to add to this vector.
-     * @param scale The scaling to apply to the input vector.
+     * @param vector - The vector to add to this vector.
+     * @param scale - The scaling to apply to the input vector.
      * @returns This instance.
      */
     addMultiply3(vector: Readonly<Vector4>, scale: number): this;
     /**
      * Scales another vector and adds its XYZ components to this vector.
-     * @param x The value to add to the X component.
-     * @param y The value to add to the Y component.
-     * @param z The value to add to the Z component.
-     * @param scale The scaling to apply to the input vector.
+     * @param x - The value to add to the X component.
+     * @param y - The value to add to the Y component.
+     * @param z - The value to add to the Z component.
+     * @param scale - The scaling to apply to the input vector.
      * @returns This instance.
      */
     addMultiply3XYZ(x: number, y: number, z: number, scale: number): this;
     /**
      * Subtracts the XYZ components of another vector from this vector.
-     * @param vector The vector to subtract from this vector.
+     * @param vector - The vector to subtract from this vector.
      * @returns This instance.
      */
     subtract3(vector: Readonly<Vector4>): this;
     /**
      * Subtracts the XYZ components of another vector from this vector.
-     * @param x The value to subtract from the X component.
-     * @param y The value to subtract from the Y component.
-     * @param z The value to subtract from the Z component.
+     * @param x - The value to subtract from the X component.
+     * @param y - The value to subtract from the Y component.
+     * @param z - The value to subtract from the Z component.
      * @returns This instance.
      */
     subtract3XYZ(x: number, y: number, z: number): this;
     /**
      * Multiplies the XYZ components of this vector by another vector.
-     * @param vector The vector to multiply with this vector.
+     * @param vector - The vector to multiply with this vector.
      * @returns This instance.
      */
     multiply3(vector: Readonly<Vector4>): this;
     /**
      * Multiplies the XYZ components of this vector by another vector.
-     * @param x The value to multiply with the X component.
-     * @param y The value to multiply with the Y component.
-     * @param z The value to multiply with the Z component.
+     * @param x - The value to multiply with the X component.
+     * @param y - The value to multiply with the Y component.
+     * @param z - The value to multiply with the Z component.
      * @returns This instance.
      */
     multiply3XYZ(x: number, y: number, z: number): this;
     /**
      * Multiplies the XYZ components of the vector by the given scale.
-     * @param scale The scaling to apply to the vector.
+     * @param scale - The scaling to apply to the vector.
      * @returns This instance.
      */
     multiply3Scale(scale: number): this;
     /**
      * Divides the XYZ components of this vector by another vector.
-     * @param vector The vector to divide this vector with.
+     * @param vector - The vector to divide this vector with.
      * @returns This instance.
      */
     divide3(vector: Readonly<Vector4>): this;
     /**
      * Divides the XYZ components of this vector by another vector.
-     * @param x The value to divide the X component with.
-     * @param y The value to divide the Y component with.
-     * @param z The value to divide the Z component with.
+     * @param x - The value to divide the X component with.
+     * @param y - The value to divide the Y component with.
+     * @param z - The value to divide the Z component with.
      * @returns This instance.
      */
     divide3XYZ(x: number, y: number, z: number): this;
     /**
      * Divides the XYZ components of the vector by the given scale.
-     * @param scale The scaling to apply to the vector.
+     * @param scale - The scaling to apply to the vector.
      * @returns This instance.
      */
     divide3Scale(scale: number): this;
@@ -168,15 +168,15 @@ export declare class Vector4 {
     invertMultiply3(): this;
     /**
      * Clamps the components of the vector at the given boundary.
-     * @param floor The lowest value to allow.
-     * @param ceil The largest value to allow.
+     * @param floor - The lowest value to allow.
+     * @param ceil - The largest value to allow.
      * @returns This instance.
      */
     clamp(floor: number, ceil: number): this;
     /**
      * Linearly moves this vector towards a target vector.
-     * @param vector The target vector.
-     * @param t The location on the scale, from `0` to `1`.
+     * @param vector - The target vector.
+     * @param t - The location on the scale, from `0` to `1`.
      * @returns This instance.
      */
     lerp(vector: Readonly<Vector4>, t: number): this;