@oliversalzburg/js-utils 0.0.23-dev.4 → 0.0.23-dev.6

package/math/core.d.ts

@@ -9,28 +9,28 @@ export declare const TWO_PI: number;
  * @returns The degrees in radians.
  * @group Math
  */
-export declare const deg2rad: (degrees: number) => number;
+export declare const degreesToRadians: (degrees: number) => number;
 /**
  * Convertrs the radians to degrees.
  * @param radians - The radians to convert to degrees.
  * @returns The radians as degrees.
  * @group Math
  */
-export declare const rad2deg: (radians: number) => number;
+export declare const radiansToDegrees: (radians: number) => number;
 /**
  * Calculates the sine for a given degree value.
  * @param value - The value in degrees to calculate the sine for.
  * @returns The sine for the given value.
  * @group Math
  */
-export declare const sinDeg: (value: number) => number;
+export declare const sinDegrees: (value: number) => number;
 /**
  * Calculates the cosine for a given degree value.
  * @param value - The value in degrees to calculate the cosine for.
  * @returns The cosine for the given value.
  * @group Math
  */
-export declare const cosDeg: (value: number) => number;
+export declare const cosDegrees: (value: number) => number;
 /**
  * Calculates the distance between two vectors.
  * @param x1 - The X component of the first vector.

package/math/core.js

@@ -2,14 +2,14 @@
  * `PI` times 2.
  * @group Math
  */
-export const TWO_PI = /* @__PURE__ */ Math.PI * 2;
+export const TWO_PI = /* __PURE__ */ Math.PI * 2;
 /**
  * Converts the degrees to radians.
  * @param degrees - The degrees to convert to radians.
  * @returns The degrees in radians.
  * @group Math
  */
-export const deg2rad = (degrees) => {
+export const degreesToRadians = (degrees) => {
     return degrees * (Math.PI / 180);
 };
 /**
@@ -18,7 +18,7 @@ export const deg2rad = (degrees) => {
  * @returns The radians as degrees.
  * @group Math
  */
-export const rad2deg = (radians) => {
+export const radiansToDegrees = (radians) => {
     return radians * (180 / Math.PI);
 };
 /**
@@ -27,8 +27,8 @@ export const rad2deg = (radians) => {
  * @returns The sine for the given value.
  * @group Math
  */
-export const sinDeg = (value) => {
-    return Math.sin(deg2rad(value));
+export const sinDegrees = (value) => {
+    return Math.sin(degreesToRadians(value));
 };
 /**
  * Calculates the cosine for a given degree value.
@@ -36,8 +36,8 @@ export const sinDeg = (value) => {
  * @returns The cosine for the given value.
  * @group Math
  */
-export const cosDeg = (value) => {
-    return Math.cos(deg2rad(value));
+export const cosDegrees = (value) => {
+    return Math.cos(degreesToRadians(value));
 };
 /**
  * Calculates the distance between two vectors.

package/math/core.js.map

@@ -1 +1 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["../../source/math/core.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAElD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,EAAE;IACzC,OAAO,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,EAAE;IACzC,OAAO,OAAO,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,EAAE;IACtC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,EAAE;IACtC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAE;IACzE,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,IAAI,CAAC,KAAK,KAAK,EAAE;QACf,OAAO,CAAC,CAAC;KACV,CAAC,oBAAoB;IACtB,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,8BAA8B;IACrD,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC7B,OAAO,EAAE,GAAG,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,CAAC;QACP,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;KAC1B;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,IAAY,EAAU,EAAE;IAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC"}
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../source/math/core.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE;IAClD,OAAO,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE;IAClD,OAAO,OAAO,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAE;IACzE,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,IAAI,CAAC,KAAK,KAAK,EAAE;QACf,OAAO,CAAC,CAAC;KACV,CAAC,oBAAoB;IACtB,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,8BAA8B;IACrD,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC7B,OAAO,EAAE,GAAG,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,CAAC;QACP,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;KAC1B;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,IAAY,EAAU,EAAE;IAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC"}

package/nil.d.ts

@@ -15,21 +15,26 @@ export type Maybe<T> = T | Nil;
  * Check if something is nil.
  * Can be used as a typeguard.
  * @param subject - The subject that could be nil.
+ * @typeParam TSubject - The type of the subject.
  * @returns `true` if the subject is nil, `false` otherwise.
+ * @group Nullability
  */
-export declare function isNil<T>(subject: Maybe<T>): subject is Nil;
+export declare function isNil<TSubject>(subject: Maybe<TSubject>): subject is Nil;
 /**
  * Check if something is a concrete value of the given type.
  * Can be used as a typeguard.
- * @param nilable - The subject that could be nil.
- * @param InstanceType - The type to check against.
+ * @param subject - The subject that could be nil.
+ * @param Prototype - The prototype to check against.
+ * @typeParam TSubject - The type to check against.
  * @returns `true` if the input element matches the given type,
  * `false` otherwise.
+ * @group Nullability
  */
-export declare function is<T>(nilable: Maybe<T>, InstanceType: ConstructorOf<T>): nilable is T;
+export declare function is<TSubject>(subject: Maybe<TSubject>, Prototype: ConstructorOf<TSubject>): subject is TSubject;
 /**
  * Thrown when an unexpected nil value was encountered.
  * @group Errors
+ * @group Nullability
  */
 export declare class UnexpectedNilError extends Error {
     /**
@@ -42,13 +47,17 @@ export declare class UnexpectedNilError extends Error {
  * Ensure that the passed subject is not nil; throw otherwise.
  * @param subject - A subject that is possible nil.
  * @param errorMessage - An optional error message to throw when the subject is nil.
+ * @typeParam TSubject - The type of the subject.
  * @returns The subject, if it isn't nil.
  * @throws {@linkcode UnexpectedNilError} When the subject is nil.
+ * @group Nullability
  */
-export declare function mustExist<T>(subject: Maybe<T>, errorMessage?: string): T;
+export declare function mustExist<TSubject>(subject: Maybe<TSubject>, errorMessage?: string): TSubject;
 /**
  * Ensure that the passed subject is not nil; throw otherwise.
  * @param subject - A subject that is possibly nil.
+ * @typeParam TSubject - The type of the subject.
  * @throws {@linkcode UnexpectedNilError} When the subject is nil.
+ * @group Nullability
  */
-export declare function assertExists<T>(subject: Maybe<T>): asserts subject is T;
+export declare function assertExists<TSubject>(subject: Maybe<TSubject>): asserts subject is TSubject;

package/nil.js

@@ -2,7 +2,9 @@
  * Check if something is nil.
  * Can be used as a typeguard.
  * @param subject - The subject that could be nil.
+ * @typeParam TSubject - The type of the subject.
  * @returns `true` if the subject is nil, `false` otherwise.
+ * @group Nullability
  */
 export function isNil(subject) {
     return subject === null || subject === undefined;
@@ -10,17 +12,20 @@ export function isNil(subject) {
 /**
  * Check if something is a concrete value of the given type.
  * Can be used as a typeguard.
- * @param nilable - The subject that could be nil.
- * @param InstanceType - The type to check against.
+ * @param subject - The subject that could be nil.
+ * @param Prototype - The prototype to check against.
+ * @typeParam TSubject - The type to check against.
  * @returns `true` if the input element matches the given type,
  * `false` otherwise.
+ * @group Nullability
  */
-export function is(nilable, InstanceType) {
-    return !isNil(nilable) && nilable instanceof InstanceType;
+export function is(subject, Prototype) {
+    return !isNil(subject) && subject instanceof Prototype;
 }
 /**
  * Thrown when an unexpected nil value was encountered.
  * @group Errors
+ * @group Nullability
  */
 export class UnexpectedNilError extends Error {
     /**
@@ -35,8 +40,10 @@ export class UnexpectedNilError extends Error {
  * Ensure that the passed subject is not nil; throw otherwise.
  * @param subject - A subject that is possible nil.
  * @param errorMessage - An optional error message to throw when the subject is nil.
+ * @typeParam TSubject - The type of the subject.
  * @returns The subject, if it isn't nil.
  * @throws {@linkcode UnexpectedNilError} When the subject is nil.
+ * @group Nullability
  */
 export function mustExist(subject, errorMessage) {
     if (isNil(subject)) {
@@ -47,7 +54,9 @@ export function mustExist(subject, errorMessage) {
 /**
  * Ensure that the passed subject is not nil; throw otherwise.
  * @param subject - A subject that is possibly nil.
+ * @typeParam TSubject - The type of the subject.
  * @throws {@linkcode UnexpectedNilError} When the subject is nil.
+ * @group Nullability
  */
 export function assertExists(subject) {
     if (isNil(subject)) {

package/nil.js.map

@@ -1 +1 @@
-{"version":3,"file":"nil.js","sourceRoot":"","sources":["../source/nil.ts"],"names":[],"mappings":"AAgBA;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAI,OAAiB;IACxC,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,EAAE,CAAI,OAAiB,EAAE,YAA8B;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,YAAY,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;;;OAGG;IACH,YAAY,OAAO,GAAG,sBAAsB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAI,OAAiB,EAAE,YAAqB;IACnE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,CAAC,YAAY,CAAC,CAAC;KAC5C;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAI,OAAiB;IAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;KAChC;AACH,CAAC"}
+{"version":3,"file":"nil.js","sourceRoot":"","sources":["../source/nil.ts"],"names":[],"mappings":"AAgBA;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CAAW,OAAwB;IACtD,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC;AACnD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAChB,OAAwB,EACxB,SAAkC;IAElC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,SAAS,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;;;OAGG;IACH,YAAY,OAAO,GAAG,sBAAsB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAW,OAAwB,EAAE,YAAqB;IACjF,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,CAAC,YAAY,CAAC,CAAC;KAC5C;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAW,OAAwB;IAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;KAChC;AACH,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@oliversalzburg/js-utils",
-  "version": "0.0.23-dev.4",
+  "version": "0.0.23-dev.6",
   "license": "MIT",
   "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
   "repository": {