type-guardians 1.1.1 → 1.2.0

package/README.md

@@ -37,7 +37,7 @@ function greet(name: unknown) {
 
 ### `assert` functions
 
-`assert` functions are assertions that throw a `TypeError` if the input value is not of the expected type. You can use them to ensure that a variable has a certain type before using it.
+`assert` functions are assertions that throw a `TypeError` if the input value is not of the expected type. You can use them to ensure that a variable has a certain type before using it. You can also provide a custom error message as an optional second parameter.
 
 ```typescript
 import { assertNumber } from "type-guardians/number";
@@ -54,9 +54,9 @@ function double(value: unknown) {
 ### String
 
 - `isString(value: unknown): value is string`
-- `assertString(value: unknown): asserts value is string`
+- `assertString(value: unknown, message?: string): asserts value is string`
 
 ### Number
 
 - `isNumber(value: unknown): value is number`
-- `assertNumber(value: unknown): asserts value is number`
+- `assertNumber(value: unknown, message?: string): asserts value is number`

package/number.ts

@@ -2,6 +2,9 @@ export function isNumber(value: unknown): value is string {
 	return typeof value === "number";
 }
 
-export function assertNumber(value: unknown): asserts value is number {
-	if (typeof value !== "number") throw new TypeError(`Expected a number, received ${typeof value}`);
+export function assertNumber(
+	value: unknown,
+	message = `Expected a number, received ${typeof value}`,
+): asserts value is number {
+	if (typeof value !== "number") throw new TypeError(message);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-guardians",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "",
   "keywords": [],
   "repository": "https://github.com/pchalupa/type-guardians",
@@ -13,6 +13,7 @@
   "type": "module",
   "devDependencies": {
     "@biomejs/biome": "2.1.4",
+    "@vitest/coverage-v8": "3.1.2",
     "typescript": "^5.9.2",
     "vitest": "^3.1.2"
   },

package/string.ts

@@ -2,6 +2,9 @@ export function isString(value: unknown): value is string {
 	return typeof value === "string";
 }
 
-export function assertString(value: unknown): asserts value is string {
-	if (typeof value !== "string") throw new TypeError(`Expected a string, received ${typeof value}`);
+export function assertString(
+	value: unknown,
+	message = `Expected a string, received ${typeof value}`,
+): asserts value is string {
+	if (typeof value !== "string") throw new TypeError(message);
 }