xdbc 1.0.217 → 1.0.219

package/src/DBC/AE.ts

@@ -1,288 +1,269 @@
-import { DBC } from "../DBC";
-/**
- * A {@link DBC } defining that all elements of an {@link object }s have to fulfill
- * a given {@link object }'s check-method (**( toCheck : any ) => boolean | string**).
- *
- * @remarks
- * Maintainer: Callari, Salvatore (XDBC@WaXCode.net) */
-export class AE extends DBC {
-	// #region Condition checking.
-	/**
-	 * Checks each element of the **value**-{@link Array < any >} against the given **condition**, if it is one. If it is not
-	 * the **value** itself will be checked.
-	 *
-	 * @param condition	The { check: (toCheck: any) => boolean | string } to check the **value** against.
-	 * @param value		Either **value**-{@link Array < any >}, which's elements will be checked, or the value to be
-	 * 					checked itself.
-	 * @param index		If specified with **idxEnd** being undefined, this {@link Number } will be seen as the index of
-	 * 					the value-{@link Array }'s element to check. If value isn't an {@link Array } this parameter
-	 * 					will not have any effect.
-	 * 					With **idxEnd** not undefined this parameter indicates the beginning of the span of elements to
-	 * 					check within the value-{@link Array }.
-	 * @param idxEnd	Indicates the last element's index (including) of the span of value-{@link Array } elements to check.
-	 * 					Setting this parameter to -1 specifies that all value-{@link Array }'s elements beginning from the
-	 * 					specified **index** shall be checked.
-	 *
-	 * @returns As soon as the **condition** returns a {@link string }, instead of TRUE, the returned string. TRUE if the
-	 * 			**condition** never returns a {@link string}. */
-	public static checkAlgorithm(
-		condition: {
-			check: (toCheck: unknown | null | undefined) => boolean | string;
-		},
-		value: object,
-		index: number | undefined,
-		idxEnd: number | undefined,
-	): boolean | string {
-		if (Array.isArray(value)) {
-			if (index !== undefined && idxEnd === undefined) {
-				if (index > -1 && index < value.length) {
-					const result = condition.check(value[index]);
-
-					if (typeof result === "string") {
-						return `Violating-Arrayelement at index "${index}" with value "${value[index]}". ${result}`;
-					}
-				}
-
-				return true; // In order for optional parameter to not cause an error if they are omitted.
-			}
-
-			const ending =
-				idxEnd !== undefined
-					? idxEnd !== -1
-						? idxEnd + 1
-						: (value as []).length
-					: (value as []).length;
-
-			for (let i = index ? index : 0; i < ending; i++) {
-				const result = condition.check(value[i]);
-
-				if (result !== true) {
-					return `Violating-Arrayelement at index ${i}. ${result}`;
-				}
-			}
-		} else {
-			return condition.check(value);
-		}
-
-		return true;
-	}
-	/**
-	 * A parameter-decorator factory using the {@link AE.checkAlgorithm } with either multiple or a single one
-	 * of the **realConditions** to check the tagged parameter-value against with.
-	 * When specifying an **index** and the tagged parameter's **value** is an {@link Array }, the **realConditions** apply to the
-	 * element at the specified **index**.
-	 * If the {@link Array } is too short the currently processed { check: (toCheck: any) => boolean | string } of
-	 * **realConditions** will be verified to TRUE automatically, considering optional parameters.
-	 * If an **index** is specified but the tagged parameter's value isn't an array, the **index** is treated as being undefined.
-	 * If **index** is undefined and the tagged parameter's value is an {@link Array } each element of it will be checked
-	 * against the **realConditions**.
-	 *
-	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
-	 * 							against with.
-	 * @param index				See the {@link AE.checkAlgorithm }.
-	 * @param idxEnd			See the {@link AE.checkAlgorithm }.
-	 * @param path				See {@link DBC.decPrecondition }.
-	 * @param hint				See {@link DBC.decPrecondition }.
-	 * @param dbc				See {@link DBC.decPrecondition }.
-	 *
-	 * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of **realConditions** returns one.
-	 * 			Otherwise TRUE. */
-	public static PRE(
-		realConditions:
-			| Array<{
-					check: (toCheck: unknown | undefined | null) => boolean | string;
-			  }>
-			| { check: (toCheck: unknown | undefined | null) => boolean | string },
-		index: number | undefined = undefined,
-		idxEnd: number | undefined = undefined,
-		path: string | undefined = undefined,
-		hint: string | undefined = undefined,
-		dbc: string | undefined = undefined,
-	): (
-		target: object,
-		methodName: string | symbol | undefined,
-		parameterIndex: number,
-	) => void {
-		return DBC.decPrecondition(
-			(
-				// biome-ignore lint/suspicious/noExplicitAny: Must match DBC.decPrecondition signature
-				value: any,
-				target: object,
-				methodName: string | symbol | undefined,
-				parameterIndex: number,
-			) => {
-				if (Array.isArray(realConditions)) {
-					for (const currentCondition of realConditions) {
-						const result = AE.checkAlgorithm(
-							currentCondition,
-							value,
-							index,
-							idxEnd,
-						);
-
-						if (typeof result !== "boolean") return result;
-					}
-				} else {
-					return AE.checkAlgorithm(
-						realConditions as {
-							check: (toCheck: unknown | undefined | null) => boolean | string;
-						},
-						value,
-						index,
-						idxEnd,
-					);
-				}
-
-				return true;
-			},
-			dbc,
-			path,
-			hint,
-		);
-	}
-	/**
-	 * A method-decorator factory using the {@link AE.checkAlgorithm } with either multiple or a single one
-	 * of the **realConditions** to check the tagged method's return-value against with.
-	 *
-	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
-	 * 							against with.
-	 * @param index				See the {@link AE.checkAlgorithm }.
-	 * @param idxEnd			See the {@link AE.checkAlgorithm }.
-	 * @param path				See {@link DBC.decPrecondition }.
-	 * @param hint				See {@link DBC.decPrecondition }.
-	 * @param dbc				See {@link DBC.decPrecondition }.
-	 *
-	 * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of **realConditions** return one.
-	 * 			Otherwise TRUE. */
-	public static POST(
-		realConditions: // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| Array<{ check: (toCheck: any) => boolean | string }>
-			// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| { check: (toCheck: any) => boolean | string },
-		index: number | undefined = undefined,
-		idxEnd: number | undefined = undefined,
-		path: string | undefined = undefined,
-		hint: string | undefined = undefined,
-		dbc: string | undefined = undefined,
-	): (
-		target: object,
-		propertyKey: string,
-		descriptor: PropertyDescriptor,
-	) => PropertyDescriptor {
-		return DBC.decPostcondition(
-			(value: object, target: object, propertyKey: string) => {
-				if (Array.isArray(realConditions)) {
-					for (const currentCondition of realConditions) {
-						const result = AE.checkAlgorithm(
-							currentCondition,
-							value,
-							index,
-							idxEnd,
-						);
-
-						if (typeof result !== "boolean") return result;
-					}
-				} else {
-					return AE.checkAlgorithm(
-						// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-						realConditions as { check: (toCheck: any) => boolean | string },
-						value,
-						index,
-						idxEnd,
-					);
-				}
-
-				return true;
-			},
-			dbc,
-			path,
-			hint,
-		);
-	}
-	/**
-	 * A field-decorator factory using the {@link AE.checkAlgorithm } with either multiple or a single one
-	 * of the **realConditions** to check the tagged field.
-	 *
-	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
-	 * 							against with.
-	 * @param index				See the {@link AE.checkAlgorithm }.
-	 * @param idxEnd			See the {@link AE.checkAlgorithm }.
-	 * @param path				See {@link DBC.decInvariant }.
-	 * @param hint				See {@link DBC.decInvariant }.
-	 * @param dbc				See {@link DBC.decInvariant }.
-	 *
-	 * @returns	See {@link DBC.decInvariant }. */
-	public static INVARIANT(
-		realConditions: // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| Array<{ check: (toCheck: any) => boolean | string }>
-			// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| { check: (toCheck: any) => boolean | string },
-		index: number | undefined = undefined,
-		idxEnd: number | undefined = undefined,
-		path: string | undefined = undefined,
-		hint: string | undefined = undefined,
-		dbc: string | undefined = undefined,
-	) {
-		return DBC.createINVARIANT(
-			AE,
-			[realConditions, index, idxEnd],
-			dbc,
-			path,
-			hint,
-		);
-	}
-	// #endregion Condition checking.
-	// #region Referenced Condition checking.
-	//
-	// For usage in dynamic scenarios (like global functions).
-	//
-	/**
-	 * Invokes the {@link AE.checkAlgorithm } with all {@link AE.conditions } and the {@link object } {@link toCheck },
-	 * {@link AE.index } & {@link AE.idxEnd }.
-	 *
-	 * @param toCheck See {@link AE.checkAlgorithm }.
-	 *
-	 * @returns See {@link EQ.checkAlgorithm}. */
-	// biome-ignore lint/suspicious/noExplicitAny: Must match DBC factory signature
-	public check(toCheck: any) {
-		if (Array.isArray(this.conditions)) {
-			for (const currentCondition of this.conditions) {
-				const result = AE.checkAlgorithm(
-					currentCondition,
-					toCheck,
-					this.index,
-					this.idxEnd,
-				);
-
-				if (typeof result !== "boolean") return result;
-			}
-		} else {
-			return AE.checkAlgorithm(
-				// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-				this.conditions as { check: (toCheck: any) => boolean | string },
-				toCheck,
-				this.index,
-				this.idxEnd,
-			);
-		}
-
-		return true;
-	}
-	/**
-	 * Creates this {@link AE } by setting the protected property {@link AE.conditions }, {@link AE.index } and {@link AE.idxEnd } used by {@link AE.check }.
-	 *
-	 * @param equivalent See {@link EQ.check }. */
-	public constructor(
-		protected conditions: // biome-ignore lint/suspicious/noExplicitAny: Must match DBC factory signature
-			| Array<{
-					check: (toCheck: any) => boolean | string;
-			  }>
-			// biome-ignore lint/suspicious/noExplicitAny: Must match DBC factory signature
-			| { check: (toCheck: any) => boolean | string },
-		protected index: number | undefined = undefined,
-		protected idxEnd: number | undefined = undefined,
-	) {
-		super();
-	}
-	// #endregion Referenced Condition checking.
-}
+import { DBC } from "../DBC";
+/**
+ * A {@link DBC } defining that all elements of an {@link object }s have to fulfill
+ * a given {@link object }'s check-method (**( toCheck : any ) => boolean | string**).
+ *
+ * @remarks
+ * Maintainer: Callari, Salvatore (XDBC@WaXCode.net) */
+export class AE extends DBC {
+	// #region Condition checking.
+	/**
+	 * Checks each element of the **value**-{@link Array < any >} against the given **condition**, if it is one. If it is not
+	 * the **value** itself will be checked.
+	 *
+	 * @param condition	The { check: (toCheck: any) => boolean | string } to check the **value** against.
+	 * @param value		Either **value**-{@link Array < any >}, which's elements will be checked, or the value to be
+	 * 					checked itself.
+	 * @param index		If specified with **idxEnd** being undefined, this {@link Number } will be seen as the index of
+	 * 					the value-{@link Array }'s element to check. If value isn't an {@link Array } this parameter
+	 * 					will not have any effect.
+	 * 					With **idxEnd** not undefined this parameter indicates the beginning of the span of elements to
+	 * 					check within the value-{@link Array }.
+	 * @param idxEnd	Indicates the last element's index (including) of the span of value-{@link Array } elements to check.
+	 * 					Setting this parameter to -1 specifies that all value-{@link Array }'s elements beginning from the
+	 * 					specified **index** shall be checked.
+	 *
+	 * @returns As soon as the **condition** returns a {@link string }, instead of TRUE, the returned string. TRUE if the
+	 * 			**condition** never returns a {@link string}. */
+	public static checkAlgorithm(
+		condition: {
+			check: (toCheck: unknown | null | undefined) => boolean | string;
+		},
+		value: object,
+		index: number | undefined,
+		idxEnd: number | undefined,
+	): boolean | string {
+		if (Array.isArray(value)) {
+			if (index !== undefined && idxEnd === undefined) {
+				if (index > -1 && index < value.length) {
+					const result = condition.check(value[index]);
+					if (typeof result === "string") {
+						return `Violating-Arrayelement at index "${index}" with value "${value[index]}". ${result}`;
+					}
+				}
+				return true; // In order for optional parameter to not cause an error if they are omitted.
+			}
+			const ending =
+				idxEnd !== undefined
+					? idxEnd !== -1
+						? idxEnd + 1
+						: (value as []).length
+					: (value as []).length;
+			for (let i = index ? index : 0; i < ending; i++) {
+				const result = condition.check(value[i]);
+				if (result !== true) {
+					return `Violating-Arrayelement at index ${i}. ${result}`;
+				}
+			}
+		} else {
+			return condition.check(value);
+		}
+		return true;
+	}
+	/**
+	 * A parameter-decorator factory using the {@link AE.checkAlgorithm } with either multiple or a single one
+	 * of the **realConditions** to check the tagged parameter-value against with.
+	 * When specifying an **index** and the tagged parameter's **value** is an {@link Array }, the **realConditions** apply to the
+	 * element at the specified **index**.
+	 * If the {@link Array } is too short the currently processed { check: (toCheck: any) => boolean | string } of
+	 * **realConditions** will be verified to TRUE automatically, considering optional parameters.
+	 * If an **index** is specified but the tagged parameter's value isn't an array, the **index** is treated as being undefined.
+	 * If **index** is undefined and the tagged parameter's value is an {@link Array } each element of it will be checked
+	 * against the **realConditions**.
+	 *
+	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
+	 * 							against with.
+	 * @param index				See the {@link AE.checkAlgorithm }.
+	 * @param idxEnd			See the {@link AE.checkAlgorithm }.
+	 * @param path				See {@link DBC.decPrecondition }.
+	 * @param hint				See {@link DBC.decPrecondition }.
+	 * @param dbc				See {@link DBC.decPrecondition }.
+	 *
+	 * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of **realConditions** returns one.
+	 * 			Otherwise TRUE. */
+	public static PRE(
+		realConditions:
+			| Array<{
+					check: (toCheck: unknown | undefined | null) => boolean | string;
+			  }>
+			| { check: (toCheck: unknown | undefined | null) => boolean | string },
+		index: number | undefined = undefined,
+		idxEnd: number | undefined = undefined,
+		path: string | undefined = undefined,
+		hint: string | undefined = undefined,
+		dbc: string | undefined = undefined,
+	): (
+		target: object,
+		methodName: string | symbol | undefined,
+		parameterIndex: number,
+	) => void {
+		return DBC.decPrecondition(
+			(
+				value: any,
+				target: object,
+				methodName: string | symbol | undefined,
+				parameterIndex: number,
+			) => {
+				if (Array.isArray(realConditions)) {
+					for (const currentCondition of realConditions) {
+						const result = AE.checkAlgorithm(
+							currentCondition,
+							value,
+							index,
+							idxEnd,
+						);
+						if (typeof result !== "boolean") return result;
+					}
+				} else {
+					return AE.checkAlgorithm(
+						realConditions as {
+							check: (toCheck: unknown | undefined | null) => boolean | string;
+						},
+						value,
+						index,
+						idxEnd,
+					);
+				}
+				return true;
+			},
+			dbc,
+			path,
+			hint,
+		);
+	}
+	/**
+	 * A method-decorator factory using the {@link AE.checkAlgorithm } with either multiple or a single one
+	 * of the **realConditions** to check the tagged method's return-value against with.
+	 *
+	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
+	 * 							against with.
+	 * @param index				See the {@link AE.checkAlgorithm }.
+	 * @param idxEnd			See the {@link AE.checkAlgorithm }.
+	 * @param path				See {@link DBC.decPrecondition }.
+	 * @param hint				See {@link DBC.decPrecondition }.
+	 * @param dbc				See {@link DBC.decPrecondition }.
+	 *
+	 * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of **realConditions** return one.
+	 * 			Otherwise TRUE. */
+	public static POST(
+		realConditions:
+			| Array<{ check: (toCheck: any) => boolean | string }>
+			| { check: (toCheck: any) => boolean | string },
+		index: number | undefined = undefined,
+		idxEnd: number | undefined = undefined,
+		path: string | undefined = undefined,
+		hint: string | undefined = undefined,
+		dbc: string | undefined = undefined,
+	): (
+		target: object,
+		propertyKey: string,
+		descriptor: PropertyDescriptor,
+	) => PropertyDescriptor {
+		return DBC.decPostcondition(
+			(value: object, target: object, propertyKey: string) => {
+				if (Array.isArray(realConditions)) {
+					for (const currentCondition of realConditions) {
+						const result = AE.checkAlgorithm(
+							currentCondition,
+							value,
+							index,
+							idxEnd,
+						);
+						if (typeof result !== "boolean") return result;
+					}
+				} else {
+					return AE.checkAlgorithm(
+						realConditions as { check: (toCheck: any) => boolean | string },
+						value,
+						index,
+						idxEnd,
+					);
+				}
+				return true;
+			},
+			dbc,
+			path,
+			hint,
+		);
+	}
+	/**
+	 * A field-decorator factory using the {@link AE.checkAlgorithm } with either multiple or a single one
+	 * of the **realConditions** to check the tagged field.
+	 *
+	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
+	 * 							against with.
+	 * @param index				See the {@link AE.checkAlgorithm }.
+	 * @param idxEnd			See the {@link AE.checkAlgorithm }.
+	 * @param path				See {@link DBC.decInvariant }.
+	 * @param hint				See {@link DBC.decInvariant }.
+	 * @param dbc				See {@link DBC.decInvariant }.
+	 *
+	 * @returns	See {@link DBC.decInvariant }. */
+	public static INVARIANT(
+		realConditions:
+			| Array<{ check: (toCheck: any) => boolean | string }>
+			| { check: (toCheck: any) => boolean | string },
+		index: number | undefined = undefined,
+		idxEnd: number | undefined = undefined,
+		path: string | undefined = undefined,
+		hint: string | undefined = undefined,
+		dbc: string | undefined = undefined,
+	) {
+		return DBC.createINVARIANT(
+			AE,
+			[realConditions, index, idxEnd],
+			dbc,
+			path,
+			hint,
+		);
+	}
+	// #endregion Condition checking.
+	// #region Referenced Condition checking.
+	//
+	// For usage in dynamic scenarios (like global functions).
+	//
+	/**
+	 * Invokes the {@link AE.checkAlgorithm } with all {@link AE.conditions } and the {@link object } {@link toCheck },
+	 * {@link AE.index } & {@link AE.idxEnd }.
+	 *
+	 * @param toCheck See {@link AE.checkAlgorithm }.
+	 *
+	 * @returns See {@link EQ.checkAlgorithm}. */
+	public check(toCheck: any) {
+		if (Array.isArray(this.conditions)) {
+			for (const currentCondition of this.conditions) {
+				const result = AE.checkAlgorithm(
+					currentCondition,
+					toCheck,
+					this.index,
+					this.idxEnd,
+				);
+				if (typeof result !== "boolean") return result;
+			}
+		} else {
+			return AE.checkAlgorithm(
+				this.conditions as { check: (toCheck: any) => boolean | string },
+				toCheck,
+				this.index,
+				this.idxEnd,
+			);
+		}
+		return true;
+	}
+	/**
+	 * Creates this {@link AE } by setting the protected property {@link AE.conditions }, {@link AE.index } and {@link AE.idxEnd } used by {@link AE.check }.
+	 *
+	 * @param equivalent See {@link EQ.check }. */
+	public constructor(
+		protected conditions:
+			| Array<{
+					check: (toCheck: any) => boolean | string;
+			  }>
+			| { check: (toCheck: any) => boolean | string },
+		protected index: number | undefined = undefined,
+		protected idxEnd: number | undefined = undefined,
+	) {
+		super();
+	}
+	// #endregion Referenced Condition checking.
+}