feat(number): ✨ Add validateFloatNumber() and improve isNumber() (#73)

Author: xeho91

.changeset/clean-masks-peel.md

@@ -0,0 +1,5 @@
+---
+"@terminal-nerds/snippets-number": minor
+---
+
+✨ Add `validateFloatNumber()` and use zod on `isNumber()`

packages/number/source/schema/groups/float/float.test.ts

@@ -1,5 +1,38 @@
-import { describe } from "vitest";
+import { returns, throws } from "@terminal-nerds/snippets-test/unit";
+import { describe, it } from "vitest";
+import { ZodError } from "zod";
 
-describe.todo("validateFloatNumber(value)");
+import { isFloatNumber, validateFloatNumber } from "./float.ts";
 
-describe.todo("isFloatNumber(value)");
+const SAMPLE_INTEGER = 1337;
+const SAMPLE_FLOAT = 1.234;
+
+describe("validateFloatNumber(value)", () => {
+	it(throws(ZodError).on(`sample integer number`).sample(SAMPLE_INTEGER), ({ expect }) => {
+		expect(() => validateFloatNumber(SAMPLE_INTEGER)).toThrowError(ZodError);
+	});
+
+	it(throws(ZodError).on(`infinity values`).sample(`Infinity`), ({ expect }) => {
+		expect(() => validateFloatNumber(Number.NEGATIVE_INFINITY)).toThrowError(ZodError);
+		expect(() => validateFloatNumber(Number.POSITIVE_INFINITY)).toThrowError(ZodError);
+	});
+
+	it(returns().on(`sample float number`).sample(SAMPLE_FLOAT), ({ expect }) => {
+		expect(() => validateFloatNumber(SAMPLE_FLOAT)).not.toThrowError(ZodError);
+	});
+});
+
+describe("isFloatNumber(value)", () => {
+	it(returns(false).on(`sample integer number`).sample(SAMPLE_INTEGER), ({ expect }) => {
+		expect(isFloatNumber(SAMPLE_INTEGER)).toBe(false);
+	});
+
+	it(returns(false).on(`passed Infinity`).sample(`Infinity`), ({ expect }) => {
+		expect(isFloatNumber(Number.NEGATIVE_INFINITY)).toBe(false);
+		expect(isFloatNumber(Number.POSITIVE_INFINITY)).toBe(false);
+	});
+
+	it(returns(true).on(`sample float number`).sample(SAMPLE_FLOAT), ({ expect }) => {
+		expect(isFloatNumber(SAMPLE_FLOAT)).toBe(true);
+	});
+});

packages/number/source/schema/groups/float/float.ts

@@ -1,17 +1,16 @@
 import type { Float } from "type-fest/source/numeric";
+import { z } from "zod";
 
-/* import { z } from "zod"; */
-import { isFiniteNumber } from "../finite/finite.ts";
-import { isInteger } from "../integer/integer.ts";
+const FLOAT_NUMBER_SCHEMA = z.number().refine((n) => {
+	return !z.number().int().safeParse(n).success && z.number().finite().safeParse(n).success;
+}, "should not be an integer");
 
 export type { Float } from "type-fest/source/numeric";
 
-/* export const FLOAT_NUMBER_SCHEMA = z.number().; */
-
-/* export function validateFloatNumber<N extends number>(value: N): asserts value is Float<N> { */
-/* 	FLOAT_NUMBER_SCHEMA.parse(value); */
-/* } */
+export function validateFloatNumber<N extends number>(value: N): asserts value is Float<N> {
+	FLOAT_NUMBER_SCHEMA.parse(value);
+}
 
-export function isFloat<N extends number>(value: N): value is Float<N> {
-	return isFiniteNumber(value) && !isInteger(value);
+export function isFloatNumber<N extends number>(value: N): value is Float<N> {
+	return FLOAT_NUMBER_SCHEMA.safeParse(value).success;
 }