@alextheman/utility 5.19.2 → 5.20.0

package/dist/node/index.cjs

@@ -102,6 +102,53 @@ function range(start, stop, step = 1) {
 	return numbers;
 }
 //#endregion
+//#region src/root/functions/typeAssertions/isNonNullableObject.ts
+/**
+* Determines if the given input is a non-nullable object, narrowing the type down as such if it is
+*
+* @category Type Assertions
+*
+* @param input - The input to check
+*
+* @returns `true` if the input is a non-nullable object, and `false` otherwise. The input type will also be narrowed down to be a non-nullable object.
+*/
+function isNonNullableObject(input) {
+	return typeof input === "object" && input !== null;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/objectContainsKeys.ts
+/**
+* Determines if the given object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input object to check.
+* @param keys - The keys expected to be in the input object.
+*
+* @returns `true` if the input object contains all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys with an unknown value type.
+*/
+function objectContainsKeys(input, keys) {
+	const expectedKeys = Array.isArray(keys) ? keys : [keys];
+	if (expectedKeys.length === 0) return false;
+	for (const key of expectedKeys) if (!(key in input)) return false;
+	return true;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/containsKeys.ts
+/**
+* Determines if the given input is a non-nullable object, and if that object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input to check.
+* @param keys - The keys expected to be in the input if it's an object.
+*
+* @returns `true` if the input is an object containing all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys, each with an unknown value type.
+*/
+function containsKeys(input, keys) {
+	return isNonNullableObject(input) && objectContainsKeys(input, keys);
+}
+//#endregion
 //#region src/root/functions/arrayHelpers/fillArray.ts
 /**
 * Creates a new array where each element is the result of the provided callback.
@@ -129,7 +176,7 @@ function fillArray(callback, length = 1, options) {
 		return callback(index);
 	});
 	if (outputArray.some((item) => {
-		return item instanceof Promise || typeof item === "object" && item !== null && "then" in item && typeof item.then === "function";
+		return item instanceof Promise || containsKeys(item, "then") && typeof item.then === "function";
 	})) return Promise.all(outputArray);
 	return outputArray;
 }
@@ -236,7 +283,7 @@ function reduceLines(lines, { preserveTabs = true }) {
 * @returns An additional function to invoke, or a new string with the strings and interpolations from the template applied, and extraneous indents removed.
 */
 function normaliseIndents(first, ...args) {
-	if (typeof first === "object" && first !== null && !Array.isArray(first)) {
+	if (isNonNullableObject(first) && !Array.isArray(first)) {
 		const options = first;
 		return (strings, ...interpolations) => {
 			return normaliseIndents(strings, ...interpolations, options);
@@ -279,7 +326,7 @@ var CodeError = class CodeError extends Error {
 	*/
 	static check(input) {
 		if (input instanceof CodeError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string";
+		return containsKeys(input, ["message", "code"]) && typeof input.message === "string" && typeof input.code === "string";
 	}
 	static checkCaughtError(error, options) {
 		if (this.check(error)) {
@@ -392,7 +439,11 @@ var DataError = class DataError extends CodeError {
 	*/
 	static check(input) {
 		if (input instanceof DataError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string" && "data" in input && typeof input.data === "object" && input.data !== null;
+		return containsKeys(input, [
+			"data",
+			"code",
+			"message"
+		]) && typeof input.message === "string" && typeof input.code === "string" && isNonNullableObject(input.data);
 	}
 	/**
 	* Check a `DataError` against its error code

package/dist/node/index.js

@@ -78,6 +78,53 @@ function range(start, stop, step = 1) {
 	return numbers;
 }
 //#endregion
+//#region src/root/functions/typeAssertions/isNonNullableObject.ts
+/**
+* Determines if the given input is a non-nullable object, narrowing the type down as such if it is
+*
+* @category Type Assertions
+*
+* @param input - The input to check
+*
+* @returns `true` if the input is a non-nullable object, and `false` otherwise. The input type will also be narrowed down to be a non-nullable object.
+*/
+function isNonNullableObject(input) {
+	return typeof input === "object" && input !== null;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/objectContainsKeys.ts
+/**
+* Determines if the given object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input object to check.
+* @param keys - The keys expected to be in the input object.
+*
+* @returns `true` if the input object contains all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys with an unknown value type.
+*/
+function objectContainsKeys(input, keys) {
+	const expectedKeys = Array.isArray(keys) ? keys : [keys];
+	if (expectedKeys.length === 0) return false;
+	for (const key of expectedKeys) if (!(key in input)) return false;
+	return true;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/containsKeys.ts
+/**
+* Determines if the given input is a non-nullable object, and if that object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input to check.
+* @param keys - The keys expected to be in the input if it's an object.
+*
+* @returns `true` if the input is an object containing all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys, each with an unknown value type.
+*/
+function containsKeys(input, keys) {
+	return isNonNullableObject(input) && objectContainsKeys(input, keys);
+}
+//#endregion
 //#region src/root/functions/arrayHelpers/fillArray.ts
 /**
 * Creates a new array where each element is the result of the provided callback.
@@ -105,7 +152,7 @@ function fillArray(callback, length = 1, options) {
 		return callback(index);
 	});
 	if (outputArray.some((item) => {
-		return item instanceof Promise || typeof item === "object" && item !== null && "then" in item && typeof item.then === "function";
+		return item instanceof Promise || containsKeys(item, "then") && typeof item.then === "function";
 	})) return Promise.all(outputArray);
 	return outputArray;
 }
@@ -212,7 +259,7 @@ function reduceLines(lines, { preserveTabs = true }) {
 * @returns An additional function to invoke, or a new string with the strings and interpolations from the template applied, and extraneous indents removed.
 */
 function normaliseIndents(first, ...args) {
-	if (typeof first === "object" && first !== null && !Array.isArray(first)) {
+	if (isNonNullableObject(first) && !Array.isArray(first)) {
 		const options = first;
 		return (strings, ...interpolations) => {
 			return normaliseIndents(strings, ...interpolations, options);
@@ -255,7 +302,7 @@ var CodeError = class CodeError extends Error {
 	*/
 	static check(input) {
 		if (input instanceof CodeError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string";
+		return containsKeys(input, ["message", "code"]) && typeof input.message === "string" && typeof input.code === "string";
 	}
 	static checkCaughtError(error, options) {
 		if (this.check(error)) {
@@ -368,7 +415,11 @@ var DataError = class DataError extends CodeError {
 	*/
 	static check(input) {
 		if (input instanceof DataError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string" && "data" in input && typeof input.data === "object" && input.data !== null;
+		return containsKeys(input, [
+			"data",
+			"code",
+			"message"
+		]) && typeof input.message === "string" && typeof input.code === "string" && isNonNullableObject(input.data);
 	}
 	/**
 	* Check a `DataError` against its error code

package/dist/v6/index.cjs

@@ -38,6 +38,53 @@ function range(start, stop, step = 1) {
 	return numbers;
 }
 //#endregion
+//#region src/root/functions/typeAssertions/isNonNullableObject.ts
+/**
+* Determines if the given input is a non-nullable object, narrowing the type down as such if it is
+*
+* @category Type Assertions
+*
+* @param input - The input to check
+*
+* @returns `true` if the input is a non-nullable object, and `false` otherwise. The input type will also be narrowed down to be a non-nullable object.
+*/
+function isNonNullableObject(input) {
+	return typeof input === "object" && input !== null;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/objectContainsKeys.ts
+/**
+* Determines if the given object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input object to check.
+* @param keys - The keys expected to be in the input object.
+*
+* @returns `true` if the input object contains all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys with an unknown value type.
+*/
+function objectContainsKeys(input, keys) {
+	const expectedKeys = Array.isArray(keys) ? keys : [keys];
+	if (expectedKeys.length === 0) return false;
+	for (const key of expectedKeys) if (!(key in input)) return false;
+	return true;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/containsKeys.ts
+/**
+* Determines if the given input is a non-nullable object, and if that object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input to check.
+* @param keys - The keys expected to be in the input if it's an object.
+*
+* @returns `true` if the input is an object containing all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys, each with an unknown value type.
+*/
+function containsKeys(input, keys) {
+	return isNonNullableObject(input) && objectContainsKeys(input, keys);
+}
+//#endregion
 //#region src/root/functions/arrayHelpers/fillArray.ts
 /**
 * Creates a new array where each element is the result of the provided callback.
@@ -65,7 +112,7 @@ function fillArray(callback, length = 1, options) {
 		return callback(index);
 	});
 	if (outputArray.some((item) => {
-		return item instanceof Promise || typeof item === "object" && item !== null && "then" in item && typeof item.then === "function";
+		return item instanceof Promise || containsKeys(item, "then") && typeof item.then === "function";
 	})) return Promise.all(outputArray);
 	return outputArray;
 }
@@ -172,7 +219,7 @@ function reduceLines(lines, { preserveTabs = true }) {
 * @returns An additional function to invoke, or a new string with the strings and interpolations from the template applied, and extraneous indents removed.
 */
 function normaliseIndents(first, ...args) {
-	if (typeof first === "object" && first !== null && !Array.isArray(first)) {
+	if (isNonNullableObject(first) && !Array.isArray(first)) {
 		const options = first;
 		return (strings, ...interpolations) => {
 			return normaliseIndents(strings, ...interpolations, options);
@@ -215,7 +262,7 @@ var CodeError = class CodeError extends Error {
 	*/
 	static check(input) {
 		if (input instanceof CodeError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string";
+		return containsKeys(input, ["message", "code"]) && typeof input.message === "string" && typeof input.code === "string";
 	}
 	static checkCaughtError(error, options) {
 		if (this.check(error)) {
@@ -339,7 +386,11 @@ var APIError = class APIError extends CodeError {
 	*/
 	static check(input) {
 		if (input instanceof APIError) return true;
-		return typeof input === "object" && input !== null && "status" in input && typeof input.status === "number" && "code" in input && typeof input.code === "string" && "message" in input && typeof input.message === "string" && (!("data" in input) || input.data === void 0 || typeof input.data === "object" && input.data !== null);
+		return containsKeys(input, [
+			"status",
+			"code",
+			"message"
+		]) && typeof input.status === "number" && typeof input.code === "string" && typeof input.message === "string" && (!objectContainsKeys(input, "data") || input.data === void 0 || isNonNullableObject(input.data));
 	}
 	/**
 	* Check an `APIError` against its error code
@@ -446,7 +497,11 @@ var DataError = class DataError extends CodeError {
 	*/
 	static check(input) {
 		if (input instanceof DataError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string" && "data" in input && typeof input.data === "object" && input.data !== null;
+		return containsKeys(input, [
+			"data",
+			"code",
+			"message"
+		]) && typeof input.message === "string" && typeof input.code === "string" && isNonNullableObject(input.data);
 	}
 	/**
 	* Check a `DataError` against its error code

package/dist/v6/index.js

@@ -37,6 +37,53 @@ function range(start, stop, step = 1) {
 	return numbers;
 }
 //#endregion
+//#region src/root/functions/typeAssertions/isNonNullableObject.ts
+/**
+* Determines if the given input is a non-nullable object, narrowing the type down as such if it is
+*
+* @category Type Assertions
+*
+* @param input - The input to check
+*
+* @returns `true` if the input is a non-nullable object, and `false` otherwise. The input type will also be narrowed down to be a non-nullable object.
+*/
+function isNonNullableObject(input) {
+	return typeof input === "object" && input !== null;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/objectContainsKeys.ts
+/**
+* Determines if the given object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input object to check.
+* @param keys - The keys expected to be in the input object.
+*
+* @returns `true` if the input object contains all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys with an unknown value type.
+*/
+function objectContainsKeys(input, keys) {
+	const expectedKeys = Array.isArray(keys) ? keys : [keys];
+	if (expectedKeys.length === 0) return false;
+	for (const key of expectedKeys) if (!(key in input)) return false;
+	return true;
+}
+//#endregion
+//#region src/root/functions/typeAssertions/containsKeys.ts
+/**
+* Determines if the given input is a non-nullable object, and if that object contains all of the keys provided.
+*
+* @category Type Assertions
+*
+* @param input - The input to check.
+* @param keys - The keys expected to be in the input if it's an object.
+*
+* @returns `true` if the input is an object containing all provided keys, and `false` otherwise. The input type will also be narrowed down to be a record with the provided keys, each with an unknown value type.
+*/
+function containsKeys(input, keys) {
+	return isNonNullableObject(input) && objectContainsKeys(input, keys);
+}
+//#endregion
 //#region src/root/functions/arrayHelpers/fillArray.ts
 /**
 * Creates a new array where each element is the result of the provided callback.
@@ -64,7 +111,7 @@ function fillArray(callback, length = 1, options) {
 		return callback(index);
 	});
 	if (outputArray.some((item) => {
-		return item instanceof Promise || typeof item === "object" && item !== null && "then" in item && typeof item.then === "function";
+		return item instanceof Promise || containsKeys(item, "then") && typeof item.then === "function";
 	})) return Promise.all(outputArray);
 	return outputArray;
 }
@@ -171,7 +218,7 @@ function reduceLines(lines, { preserveTabs = true }) {
 * @returns An additional function to invoke, or a new string with the strings and interpolations from the template applied, and extraneous indents removed.
 */
 function normaliseIndents(first, ...args) {
-	if (typeof first === "object" && first !== null && !Array.isArray(first)) {
+	if (isNonNullableObject(first) && !Array.isArray(first)) {
 		const options = first;
 		return (strings, ...interpolations) => {
 			return normaliseIndents(strings, ...interpolations, options);
@@ -214,7 +261,7 @@ var CodeError = class CodeError extends Error {
 	*/
 	static check(input) {
 		if (input instanceof CodeError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string";
+		return containsKeys(input, ["message", "code"]) && typeof input.message === "string" && typeof input.code === "string";
 	}
 	static checkCaughtError(error, options) {
 		if (this.check(error)) {
@@ -338,7 +385,11 @@ var APIError = class APIError extends CodeError {
 	*/
 	static check(input) {
 		if (input instanceof APIError) return true;
-		return typeof input === "object" && input !== null && "status" in input && typeof input.status === "number" && "code" in input && typeof input.code === "string" && "message" in input && typeof input.message === "string" && (!("data" in input) || input.data === void 0 || typeof input.data === "object" && input.data !== null);
+		return containsKeys(input, [
+			"status",
+			"code",
+			"message"
+		]) && typeof input.status === "number" && typeof input.code === "string" && typeof input.message === "string" && (!objectContainsKeys(input, "data") || input.data === void 0 || isNonNullableObject(input.data));
 	}
 	/**
 	* Check an `APIError` against its error code
@@ -445,7 +496,11 @@ var DataError = class DataError extends CodeError {
 	*/
 	static check(input) {
 		if (input instanceof DataError) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string" && "data" in input && typeof input.data === "object" && input.data !== null;
+		return containsKeys(input, [
+			"data",
+			"code",
+			"message"
+		]) && typeof input.message === "string" && typeof input.code === "string" && isNonNullableObject(input.data);
 	}
 	/**
 	* Check a `DataError` against its error code

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.19.2",
+  "version": "5.20.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -40,27 +40,27 @@
     "execa": "9.6.1"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "5.16.1",
+    "@alextheman/eslint-plugin": "5.17.0",
     "@types/node": "25.9.1",
-    "alex-c-line": "2.8.1",
+    "alex-c-line": "2.9.1",
     "cross-env": "10.1.0",
     "dotenv-cli": "11.0.0",
-    "eslint": "10.4.0",
+    "eslint": "10.4.1",
     "globals": "17.6.0",
     "husky": "9.1.7",
     "jsdom": "29.1.1",
     "markdownlint-cli2": "0.22.1",
     "prettier": "3.8.3",
     "tempy": "3.2.0",
-    "tsdown": "0.22.1",
-    "tsx": "4.22.3",
+    "tsdown": "0.22.2",
+    "tsx": "4.22.4",
     "typedoc": "0.28.19",
-    "typedoc-plugin-markdown": "4.11.0",
+    "typedoc-plugin-markdown": "4.12.0",
     "typedoc-rhineai-theme": "1.2.0",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.60.0",
-    "vite": "8.0.14",
-    "vitest": "4.1.7",
+    "typescript-eslint": "8.60.1",
+    "vite": "8.0.16",
+    "vitest": "4.1.8",
     "zod": "4.4.3"
   },
   "engines": {