@valkyriestudios/utils 12.1.0 → 12.2.0

package/array/is.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is an array
  */
-export default function isArray(val: unknown): boolean;
+export default function isArray(val: unknown): val is unknown[];

package/array/isNotEmpty.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is an array with content
  */
-export default function isNotEmptyArray(val: unknown): boolean;
+export default function isNotEmptyArray(val: unknown): val is unknown[];

package/boolean/is.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is a boolean
  */
-export default function isBoolean(val: unknown): boolean;
+export default function isBoolean(val: unknown): val is boolean;

package/date/is.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is a Date
  */
-export default function isDate(val: unknown): boolean;
+export default function isDate(val: unknown): val is Date;

package/function/is.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is a Function
  */
-export default function isFunction(val: unknown): boolean;
+export default function isFunction(val: unknown): val is Function;

package/function/isAsync.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is an async function
  */
-export default function isAsyncFunction(val: unknown): boolean;
+export default function isAsyncFunction(val: unknown): val is Function;

package/index.d.ts

@@ -6,76 +6,80 @@ declare module "equal" {
     export default equal;
 }
 declare module "array/isNotEmpty" {
-    export default function isNotEmptyArray(val: unknown): boolean;
+    export default function isNotEmptyArray(val: unknown): val is unknown[];
 }
 declare module "array/is" {
-    export default function isArray(val: unknown): boolean;
+    export default function isArray(val: unknown): val is unknown[];
 }
 declare module "boolean/is" {
-    export default function isBoolean(val: unknown): boolean;
+    export default function isBoolean(val: unknown): val is boolean;
 }
 declare module "date/is" {
-    export default function isDate(val: unknown): boolean;
+    export default function isDate(val: unknown): val is Date;
 }
 declare module "function/is" {
-    export default function isFunction(val: unknown): boolean;
+    export default function isFunction(val: unknown): val is Function;
 }
 declare module "function/isAsync" {
-    export default function isAsyncFunction(val: unknown): boolean;
+    export default function isAsyncFunction(val: unknown): val is Function;
 }
 declare module "number/is" {
-    export default function isNumber(val: unknown): boolean;
+    export default function isNumber(val: unknown): val is number;
 }
 declare module "number/isBetween" {
-    export default function isNumberBetween(val: unknown, min: number, max: number): boolean;
+    export default function isNumberBetween(val: unknown, min: number, max: number): val is number;
 }
 declare module "number/isBelow" {
-    export default function isNumberBelow(val: unknown, ref: number): boolean;
+    export default function isNumberBelow(val: unknown, ref: number): val is number;
 }
 declare module "number/isBelowOrEqual" {
-    export default function isNumberBelowOrEqual(val: unknown, ref: number): boolean;
+    export default function isNumberBelowOrEqual(val: unknown, ref: number): val is number;
 }
 declare module "number/isAbove" {
-    export default function isNumberAbove(val: unknown, ref: number): boolean;
+    export default function isNumberAbove(val: unknown, ref: number): val is number;
 }
 declare module "number/isAboveOrEqual" {
-    export default function isNumberAboveOrEqual(val: unknown, ref: number): boolean;
+    export default function isNumberAboveOrEqual(val: unknown, ref: number): val is number;
 }
 declare module "number/isInteger" {
-    export default function isInteger(val: unknown): boolean;
+    export default function isInteger(val: unknown): val is number;
 }
 declare module "number/isIntegerBetween" {
-    export default function isIntegerBetween(val: unknown, min: number, max: number): boolean;
+    export default function isIntegerBetween(val: unknown, min: number, max: number): val is number;
 }
 declare module "number/isIntegerBelow" {
-    export default function isIntegerBelow(val: unknown, ref: number): boolean;
+    export default function isIntegerBelow(val: unknown, ref: number): val is number;
 }
 declare module "number/isIntegerBelowOrEqual" {
-    export default function isIntegerBelowOrEqual(val: unknown, ref: number): boolean;
+    export default function isIntegerBelowOrEqual(val: unknown, ref: number): val is number;
 }
 declare module "number/isIntegerAbove" {
-    export default function isIntegerAbove(val: unknown, ref: number): boolean;
+    export default function isIntegerAbove(val: unknown, ref: number): val is number;
 }
 declare module "number/isIntegerAboveOrEqual" {
-    export default function isIntegerAboveOrEqual(val: unknown, ref: number): boolean;
+    export default function isIntegerAboveOrEqual(val: unknown, ref: number): val is number;
 }
 declare module "regexp/is" {
-    export default function isRegExp(val: unknown): boolean;
+    export default function isRegExp(val: unknown): val is RegExp;
 }
 declare module "object/is" {
-    export default function isObject(val: unknown): boolean;
+    export default function isObject(val: unknown): val is {
+        [key: string]: any;
+    };
 }
 declare module "object/isNotEmpty" {
-    export default function isNotEmptyObject(val: unknown): boolean;
+    export default function isNotEmptyObject(val: unknown): val is {
+        [key: string]: any;
+    };
 }
 declare module "string/is" {
-    export default function isString(val: unknown): boolean;
+    export default function isString(val: unknown): val is string;
 }
 declare module "string/isBetween" {
-    export default function isStringBetween(val: unknown, min: number, max: number, trimmed?: boolean): boolean;
+    export default function isStringBetween(val: unknown, min: number, max: number, trimmed?: boolean): val is string;
 }
 declare module "string/isNotEmpty" {
-    export default function isNotEmptyString(val: unknown, trimmed?: boolean): boolean;
+    export default function isNotEmptyString(val: unknown, trimmed?: boolean): val is string;
 }
 declare module "is" {
     import equal from "equal";

package/number/is.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is a number
  */
-export default function isNumber(val: unknown): boolean;
+export default function isNumber(val: unknown): val is number;

package/number/isAbove.d.ts

@@ -6,4 +6,4 @@
  *
  * @returns Whether or not the value is above the reference
  */
-export default function isNumberAbove(val: unknown, ref: number): boolean;
+export default function isNumberAbove(val: unknown, ref: number): val is number;

package/number/isAboveOrEqual.d.ts

@@ -6,4 +6,4 @@
  *
  * @returns Whether or not the value is above or equal to the reference
  */
-export default function isNumberAboveOrEqual(val: unknown, ref: number): boolean;
+export default function isNumberAboveOrEqual(val: unknown, ref: number): val is number;

package/number/isBelow.d.ts

@@ -6,4 +6,4 @@
  *
  * @returns Whether or not the value is below the reference
  */
-export default function isNumberBelow(val: unknown, ref: number): boolean;
+export default function isNumberBelow(val: unknown, ref: number): val is number;

package/number/isBelowOrEqual.d.ts

@@ -7,4 +7,4 @@
  *
  * @returns Whether or not the value is below or equal to the reference
  */
-export default function isNumberBelowOrEqual(val: unknown, ref: number): boolean;
+export default function isNumberBelowOrEqual(val: unknown, ref: number): val is number;

package/number/isBetween.d.ts

@@ -9,4 +9,4 @@
  *
  * @returns Whether or not the value is a number between min and max inclusive
  */
-export default function isNumberBetween(val: unknown, min: number, max: number): boolean;
+export default function isNumberBetween(val: unknown, min: number, max: number): val is number;

package/number/isInteger.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is an integer
  */
-export default function isInteger(val: unknown): boolean;
+export default function isInteger(val: unknown): val is number;

package/number/isIntegerAbove.d.ts

@@ -6,4 +6,4 @@
  *
  * @returns Whether or not the value is above the reference
  */
-export default function isIntegerAbove(val: unknown, ref: number): boolean;
+export default function isIntegerAbove(val: unknown, ref: number): val is number;

package/number/isIntegerAboveOrEqual.d.ts

@@ -7,4 +7,4 @@
  *
  * @returns Whether or not the value is above or equal to the reference
  */
-export default function isIntegerAboveOrEqual(val: unknown, ref: number): boolean;
+export default function isIntegerAboveOrEqual(val: unknown, ref: number): val is number;

package/number/isIntegerBelow.d.ts

@@ -6,4 +6,4 @@
  *
  * @returns Whether or not the value is below the reference
  */
-export default function isIntegerBelow(val: unknown, ref: number): boolean;
+export default function isIntegerBelow(val: unknown, ref: number): val is number;

package/number/isIntegerBelowOrEqual.d.ts

@@ -7,4 +7,4 @@
  *
  * @returns Whether or not the value is below or equal to the reference
  */
-export default function isIntegerBelowOrEqual(val: unknown, ref: number): boolean;
+export default function isIntegerBelowOrEqual(val: unknown, ref: number): val is number;

package/number/isIntegerBetween.d.ts

@@ -9,4 +9,4 @@
  *
  * @returns Whether or not the value is an integer between min and max inclusive
  */
-export default function isIntegerBetween(val: unknown, min: number, max: number): boolean;
+export default function isIntegerBetween(val: unknown, min: number, max: number): val is number;

package/object/is.d.ts

@@ -5,4 +5,6 @@
  *
  * @returns Whether or not the value is an object
  */
-export default function isObject(val: unknown): boolean;
+export default function isObject(val: unknown): val is {
+    [key: string]: any;
+};

package/object/isNotEmpty.d.ts

@@ -5,4 +5,6 @@
  *
  * @returns Whether or not the value is an object with content
  */
-export default function isNotEmptyObject(val: unknown): boolean;
+export default function isNotEmptyObject(val: unknown): val is {
+    [key: string]: any;
+};

package/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.1.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "email": "contact@valkyriestudios.be", "url": "www.valkyriestudios.be" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }
+{ "name": "@valkyriestudios/utils", "version": "12.2.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "email": "contact@valkyriestudios.be", "url": "www.valkyriestudios.be" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }

package/regexp/is.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is a RegExp
  */
-export default function isRegExp(val: unknown): boolean;
+export default function isRegExp(val: unknown): val is RegExp;

package/string/is.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns Whether or not the value is a string
  */
-export default function isString(val: unknown): boolean;
+export default function isString(val: unknown): val is string;

package/string/isBetween.d.ts

@@ -10,4 +10,4 @@
  *
  * @returns Whether or not the value is a string of length between min and max inclusive
  */
-export default function isStringBetween(val: unknown, min: number, max: number, trimmed?: boolean): boolean;
+export default function isStringBetween(val: unknown, min: number, max: number, trimmed?: boolean): val is string;

package/string/isNotEmpty.d.ts

@@ -6,4 +6,4 @@
  *
  * @returns Whether or not the value is a string with content
  */
-export default function isNotEmptyString(val: unknown, trimmed?: boolean): boolean;
+export default function isNotEmptyString(val: unknown, trimmed?: boolean): val is string;