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

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

@@ -13,105 +13,105 @@ export declare class Vector2 {
     y: number;
     /**
      * Constructs a new {@linkcode Vector2}.
-     * @param x The X component.
-     * @param y The Y component.
+     * @param x - The X component.
+     * @param y - The Y component.
      */
     constructor(x: number, y: number);
     /**
      * Creates a copy of another {@linkcode Vector2}.
-     * @param vector The vector to copy.
+     * @param vector - The vector to copy.
      * @returns A new vector.
      */
     static fromVector2(vector: Readonly<Vector2>): Vector2;
     /**
      * 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<Vector2>): 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 x - The new X component for the vector.
+     * @param y - The new Y component for the vector.
      * @returns This instance.
      */
     setXY(x: number, y: number): this;
     /**
      * 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: Readonly<Vector2>): this;
     /**
      * 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 x - The value to add to the X component.
+     * @param y - The value to add to the Y component.
      * @returns This instance.
      */
     addXY(x: number, y: number): this;
     /**
      * 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: Readonly<Vector2>, scale: number): this;
     /**
      * 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 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 scale - The scaling to apply to the input vector.
      * @returns This instance.
      */
     addMultiplyXY(x: number, y: number, scale: number): this;
     /**
      * 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: Readonly<Vector2>): this;
     /**
      * 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 x - The value to subtract from the X component.
+     * @param y - The value to subtract from the Y component.
      * @returns This instance.
      */
     subtractXY(x: number, y: number): this;
     /**
      * 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: Readonly<Vector2>): this;
     /**
      * 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 x - The value to multiply with the X component.
+     * @param y - The value to multiply with the Y component.
      * @returns This instance.
      */
     multiplyXY(x: number, y: number): this;
     /**
      * 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: number): this;
     /**
      * 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: Readonly<Vector2>): this;
     /**
      * 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 x - The value to divide the X component with.
+     * @param y - The value to divide the Y component with.
      * @returns This instance.
      */
     divideXY(x: number, y: number): this;
     /**
      * 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: number): this;
@@ -127,8 +127,8 @@ export declare class Vector2 {
     invertMultiply(): 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;
@@ -144,33 +144,33 @@ export declare class Vector2 {
     normalize(): this;
     /**
      * 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: Readonly<Vector2>): boolean;
     /**
      * 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<Vector2>, t: number): this;
     /**
      * Rotates the vector by the given angle.
-     * @param angle The angle in degrees.
+     * @param angle - The angle in degrees.
      * @returns This instance.
      */
     rotate(angle: number): this;
     /**
      * 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: Readonly<Vector2>): number;
     /**
      * 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 x - The X component of the other vector.
+     * @param y - The Y component of the other vector.
      * @returns The dot product between the two vectors.
      */
     dotXY(x: number, y: number): number;
@@ -182,24 +182,24 @@ export declare class Vector2 {
 }
 /**
  * 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 Vector2}.
  * @group Math
  */
 export declare const addVector2: (a: Readonly<Vector2>, b: Readonly<Vector2>) => Vector2;
 /**
  * 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 Vector2}.
  * @group Math
  */
 export declare const multiplyVector2: (a: Readonly<Vector2>, b: Readonly<Vector2>) => Vector2;
 /**
  * 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 Vector2}.
  * @group Math
  */

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

@@ -13,8 +13,8 @@ export class Vector2 {
     y;
     /**
      * Constructs a new {@linkcode Vector2}.
-     * @param x The X component.
-     * @param y The Y component.
+     * @param x - The X component.
+     * @param y - The Y component.
      */
     constructor(x, y) {
         this.x = x;
@@ -22,7 +22,7 @@ export class Vector2 {
     }
     /**
      * Creates a copy of another {@linkcode Vector2}.
-     * @param vector The vector to copy.
+     * @param vector - The vector to copy.
      * @returns A new vector.
      */
     static fromVector2(vector) {
@@ -30,7 +30,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -38,8 +38,8 @@ export class Vector2 {
     }
     /**
      * 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 x - The new X component for the vector.
+     * @param y - The new Y component for the vector.
      * @returns This instance.
      */
     setXY(x, y) {
@@ -49,7 +49,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -57,8 +57,8 @@ export class Vector2 {
     }
     /**
      * 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 x - The value to add to the X component.
+     * @param y - The value to add to the Y component.
      * @returns This instance.
      */
     addXY(x, y) {
@@ -68,8 +68,8 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -77,9 +77,9 @@ export class Vector2 {
     }
     /**
      * 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 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 scale - The scaling to apply to the input vector.
      * @returns This instance.
      */
     addMultiplyXY(x, y, scale) {
@@ -89,7 +89,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -97,8 +97,8 @@ export class Vector2 {
     }
     /**
      * 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 x - The value to subtract from the X component.
+     * @param y - The value to subtract from the Y component.
      * @returns This instance.
      */
     subtractXY(x, y) {
@@ -108,7 +108,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -116,8 +116,8 @@ export class Vector2 {
     }
     /**
      * 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 x - The value to multiply with the X component.
+     * @param y - The value to multiply with the Y component.
      * @returns This instance.
      */
     multiplyXY(x, y) {
@@ -127,7 +127,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -137,7 +137,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -145,8 +145,8 @@ export class Vector2 {
     }
     /**
      * 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 x - The value to divide the X component with.
+     * @param y - The value to divide the Y component with.
      * @returns This instance.
      */
     divideXY(x, y) {
@@ -156,7 +156,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -184,8 +184,8 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -225,7 +225,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -233,8 +233,8 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -245,7 +245,7 @@ export class Vector2 {
     }
     /**
      * Rotates the vector by the given angle.
-     * @param angle The angle in degrees.
+     * @param angle - The angle in degrees.
      * @returns This instance.
      */
     rotate(angle) {
@@ -258,7 +258,7 @@ export class Vector2 {
     }
     /**
      * 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) {
@@ -266,8 +266,8 @@ export class Vector2 {
     }
     /**
      * 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 x - The X component of the other vector.
+     * @param y - The Y component of the other vector.
      * @returns The dot product between the two vectors.
      */
     dotXY(x, y) {
@@ -283,8 +283,8 @@ export class Vector2 {
 }
 /**
  * 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 Vector2}.
  * @group Math
  */
@@ -293,8 +293,8 @@ export const addVector2 = (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 Vector2}.
  * @group Math
  */
@@ -303,8 +303,8 @@ export const multiplyVector2 = (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 Vector2}.
  * @group Math
  */