xdbc 1.0.217 → 1.0.219

package/src/DBC/DEFINED.ts

@@ -1,122 +1,117 @@
-import { DBC } from "../DBC";
-/**
- * A {@link DBC } defining that an {@link object }s must be defined thus it's value may not be **null** or **undefined**.
- *
- * @remarks
- * Maintainer: Salvatore Callari (XDBC@WaXCode.net) */
-export class DEFINED extends DBC {
-	/**
-	 * Checks if the value **toCheck** is null or undefined.
-	 *
-	 * @param toCheck	The {@link Object } to check.
-	 *
-	 * @returns TRUE if the value **toCheck** is of the specified **type**, otherwise FALSE. */
-	// biome-ignore lint/suspicious/noExplicitAny: Necessary for dynamic type checking of also UNDEFINED.
-	public static checkAlgorithm(toCheck: any): boolean | string {
-		// biome-ignore lint/suspicious/useValidTypeof: Necessary
-		if (toCheck === undefined || toCheck === null) {
-			return `Value may not be UNDEFINED or NULL but it is ${toCheck === undefined ? "UNDEFINED" : "NULL"}`;
-		}
-
-		return true;
-	}
-	/**
-	 * A parameter-decorator factory using the {@link DEFINED.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
-	 * by the tagged parameter.
-	 *
-	 * @param type	See {@link DEFINED.checkAlgorithm }.
-	 * @param path	See {@link DBC.decPrecondition }.
-	 * @param dbc	See {@link DBC.decPrecondition }.
-	 *
-	 * @returns See {@link DBC.decPrecondition }. */
-	public static PRE(
-		path: string | undefined = undefined,
-		hint: string | undefined = undefined,
-		dbc: string | undefined = undefined,
-	): (
-		target: object,
-		methodName: string | symbol | undefined,
-		parameterIndex: number,
-	) => void {
-		return DBC.createPRE(DEFINED.checkAlgorithm, [], dbc, path, hint);
-	}
-	/**
-	 * A method-decorator factory using the {@link DEFINED.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
-	 * by the tagged method's returnvalue.
-	 *
-	 * @param type	See {@link DEFINED.checkAlgorithm }.
-	 * @param path	See {@link DBC.Postcondition }.
-	 * @param dbc	See {@link DBC.decPostcondition }.
-	 *
-	 * @returns See {@link DBC.decPostcondition }. */
-	public static POST(
-		type: string,
-		path: string | undefined = undefined,
-		hint: string | undefined = undefined,
-		dbc: string | undefined = undefined,
-	): (
-		target: object,
-		propertyKey: string,
-		descriptor: PropertyDescriptor,
-	) => PropertyDescriptor {
-		return DBC.createPOST(DEFINED.checkAlgorithm, [], dbc, path, hint);
-	}
-	/**
-	 * A field-decorator factory using the {@link DEFINED.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
-	 * by the tagged field.
-	 *
-	 * @param type	See {@link DEFINED.checkAlgorithm }.
-	 * @param path	See {@link DBC.decInvariant }.
-	 * @param dbc	See {@link DBC.decInvariant }.
-	 *
-	 * @returns See {@link DBC.decInvariant }. */
-	public static INVARIANT(
-		type: string,
-		path: string | undefined = undefined,
-		hint: string | undefined = undefined,
-		dbc: string | undefined = undefined,
-	) {
-		return DBC.createINVARIANT(DEFINED, [], dbc, path, hint);
-	}
-	// #endregion Condition checking.
-	// #region Referenced Condition checking.
-	//
-	// For usage in dynamic scenarios (like with AE-DBC).
-	//
-	/**
-	 * Invokes the {@link DEFINED.checkAlgorithm } passing the value **toCheck** and the {@link DEFINED.type } .
-	 *
-	 * @param toCheck See {@link DEFINED.checkAlgorithm }.
-	 *
-	 * @returns See {@link DEFINED.checkAlgorithm}. */
-	// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-	public check(toCheck: any) {
-		return DEFINED.checkAlgorithm(toCheck);
-	}
-	/**
-	 * Invokes the {@link DEFINED.checkAlgorithm } passing the value **toCheck** and the {@link DEFINED.type } .
-	 *
-	 * @param toCheck	See {@link DEFINED.checkAlgorithm }.
-	 * @param id		A {@link string } identifying this {@link INSTANCE } via the {@link DBC.Infringement }-Message.
-	 *
-	 * @returns The **CANDIDATE** **toCheck** doesn't fulfill this {@link DEFINED }.
-	 *
-	 * @throws A {@link DBC.Infringement } if the **CANDIDATE** **toCheck** does not fulfill this {@link DEFINED }.*/
-	public static tsCheck<CANDIDATE = unknown>(
-		toCheck: CANDIDATE | undefined | null,
-		hint: string | undefined = undefined,
-		id: string | undefined = undefined,
-		dbc: string | undefined = undefined,
-	): CANDIDATE {
-		const result = DEFINED.checkAlgorithm(toCheck);
-
-		if (result === true) {
-			return toCheck as CANDIDATE;
-		}
-		DBC.reportTsCheckInfringement(
-			`${id ? `(${id}) ` : ""}${result as string}${hint ? ` ✨ ${hint} ✨` : ""}`,
-			dbc,
-		);
-		return toCheck as CANDIDATE;
-	}
-}
+import { DBC } from "../DBC";
+/**
+ * A {@link DBC } defining that an {@link object }s must be defined thus it's value may not be **null** or **undefined**.
+ *
+ * @remarks
+ * Maintainer: Salvatore Callari (XDBC@WaXCode.net) */
+export class DEFINED extends DBC {
+	/**
+	 * Checks if the value **toCheck** is null or undefined.
+	 *
+	 * @param toCheck	The {@link Object } to check.
+	 *
+	 * @returns TRUE if the value **toCheck** is of the specified **type**, otherwise FALSE. */
+	public static checkAlgorithm(toCheck: any): boolean | string {
+		if (toCheck === undefined || toCheck === null) {
+			return `Value may not be UNDEFINED or NULL but it is ${toCheck === undefined ? "UNDEFINED" : "NULL"}`;
+		}
+		return true;
+	}
+	/**
+	 * A parameter-decorator factory using the {@link DEFINED.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+	 * by the tagged parameter.
+	 *
+	 * @param type	See {@link DEFINED.checkAlgorithm }.
+	 * @param path	See {@link DBC.decPrecondition }.
+	 * @param dbc	See {@link DBC.decPrecondition }.
+	 *
+	 * @returns See {@link DBC.decPrecondition }. */
+	public static PRE(
+		path: string | undefined = undefined,
+		hint: string | undefined = undefined,
+		dbc: string | undefined = undefined,
+	): (
+		target: object,
+		methodName: string | symbol | undefined,
+		parameterIndex: number,
+	) => void {
+		return DBC.createPRE(DEFINED.checkAlgorithm, [], dbc, path, hint);
+	}
+	/**
+	 * A method-decorator factory using the {@link DEFINED.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+	 * by the tagged method's returnvalue.
+	 *
+	 * @param type	See {@link DEFINED.checkAlgorithm }.
+	 * @param path	See {@link DBC.Postcondition }.
+	 * @param dbc	See {@link DBC.decPostcondition }.
+	 *
+	 * @returns See {@link DBC.decPostcondition }. */
+	public static POST(
+		type: string,
+		path: string | undefined = undefined,
+		hint: string | undefined = undefined,
+		dbc: string | undefined = undefined,
+	): (
+		target: object,
+		propertyKey: string,
+		descriptor: PropertyDescriptor,
+	) => PropertyDescriptor {
+		return DBC.createPOST(DEFINED.checkAlgorithm, [], dbc, path, hint);
+	}
+	/**
+	 * A field-decorator factory using the {@link DEFINED.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+	 * by the tagged field.
+	 *
+	 * @param type	See {@link DEFINED.checkAlgorithm }.
+	 * @param path	See {@link DBC.decInvariant }.
+	 * @param dbc	See {@link DBC.decInvariant }.
+	 *
+	 * @returns See {@link DBC.decInvariant }. */
+	public static INVARIANT(
+		type: string,
+		path: string | undefined = undefined,
+		hint: string | undefined = undefined,
+		dbc: string | undefined = undefined,
+	) {
+		return DBC.createINVARIANT(DEFINED, [], dbc, path, hint);
+	}
+	// #endregion Condition checking.
+	// #region Referenced Condition checking.
+	//
+	// For usage in dynamic scenarios (like with AE-DBC).
+	//
+	/**
+	 * Invokes the {@link DEFINED.checkAlgorithm } passing the value **toCheck** and the {@link DEFINED.type } .
+	 *
+	 * @param toCheck See {@link DEFINED.checkAlgorithm }.
+	 *
+	 * @returns See {@link DEFINED.checkAlgorithm}. */
+	public check(toCheck: any) {
+		return DEFINED.checkAlgorithm(toCheck);
+	}
+	/**
+	 * Invokes the {@link DEFINED.checkAlgorithm } passing the value **toCheck** and the {@link DEFINED.type } .
+	 *
+	 * @param toCheck	See {@link DEFINED.checkAlgorithm }.
+	 * @param id		A {@link string } identifying this {@link INSTANCE } via the {@link DBC.Infringement }-Message.
+	 *
+	 * @returns The **CANDIDATE** **toCheck** doesn't fulfill this {@link DEFINED }.
+	 *
+	 * @throws A {@link DBC.Infringement } if the **CANDIDATE** **toCheck** does not fulfill this {@link DEFINED }.*/
+	public static tsCheck<CANDIDATE = unknown>(
+		toCheck: CANDIDATE | undefined | null,
+		hint: string | undefined = undefined,
+		id: string | undefined = undefined,
+		dbc: string | undefined = undefined,
+	): CANDIDATE {
+		const result = DEFINED.checkAlgorithm(toCheck);
+		if (result === true) {
+			return toCheck as CANDIDATE;
+		}
+		DBC.reportTsCheckInfringement(
+			`${id ? `(${id}) ` : ""}${result as string}${hint ? ` ✨ ${hint} ✨` : ""}`,
+			dbc,
+		);
+		return toCheck as CANDIDATE;
+	}
+}