assertie 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.3.1](https://github.com/OfficialHalfwayDead/assertie/compare/v0.3.0...v0.3.1) (2025-02-23)
+
+* [`0d59837`](https://github.com/OfficialHalfwayDead/assertie/commit/0d59837841707c963ce174e79a527fcb1379ac4f) Add array and tuple assertions to the README.
+
+
 ## [0.3.0](https://github.com/OfficialHalfwayDead/assertie/compare/v0.2.0...v0.3.0) (2025-02-23)
 
 ### Breaking Changes
@@ -17,6 +22,7 @@
 
 * [`075fecd`](https://github.com/OfficialHalfwayDead/assertie/commit/075fecd105030191eac671d8731765f4f5af2cd4) Add JSDoc comments to all functions and improve documentation overall.
 
+
 ## [0.2.0](https://github.com/OfficialHalfwayDead/assertie/compare/v0.1.0...v0.2.0) (2025-02-17)
 
 ### Breaking Changes

package/README.md

@@ -154,6 +154,28 @@ const safeObj = obj;
 
 The reason an array is needed here is because undefined properties may not be present in `Object.keys`, so the caller needs to provide all keys to check. Don't worry about the safety, though. If you forget to pass a key, its type will remain nullable after the assert and TypeScript will not consider it safe to access.
 
+### Arrays and tuples
+
+Arrays and tuples have equivalent versions of `assertType` and `assertNonNullable`. These make it easy to check every element at once and get great errors and type narrowing.
+
+```ts
+const arr: (number | string | null)[] = [1, 2, 3];
+assertArrayNonNullable(arr); // narrows to (number | string)[]
+assertArrayType(arr, "number"); // narrows to number[]
+```
+
+```ts
+const arr: number[] = [1, 2, 3];
+assertIsTuple(arr, 3); // narrows to [number, number, number]
+
+const arrMixed: (number | string | null)[] = [1, "a"];
+assertIsTuple(arrMixed, 2); // narrows to [T, T]
+// where T = number | string | null;
+assertTupleNonNullable(arrMixed); // narrows T to number | string
+assertTupleTypes(arrMixed, ["number", "string"]);
+const tup: [number, string] = arrMixed;
+```
+
 ### Asserting unreachable code
 
 The unreachable assertion will

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assertie",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Debug assertions for TypeScript, auto tree-shaken by vite for production.",
   "keywords": [
     "TypeScript",

package/manual_test/index.ts

@@ -1,35 +0,0 @@
-import { assertArrayNonNullable, assertIsTuple, assertTupleNonNullable, assertTupleTypes, assertType } from "../src/index";
-
-const func = (tuple: [unknown, unknown, unknown]) => {
-    console.log(tuple);
-}
-
-const tuple: [unknown, unknown, unknown] = [1, 2, 3];
-const tuple3 = [1, 2, 3] as const;
-const tuple1: [number | undefined, number] = [1, 2];
-const arr: (number|null)[] = [1, 2, 3];
-assertIsTuple(arr, 2);
-assertTupleNonNullable(arr);
-const nntuple1: [number, number] = arr;
-tuple1[0] = 1;
-// assertTupleTypes(tuple3, ["number", "number", "number"]);
-
-type Tuple<T, N extends number, A extends unknown[] = []> = A extends { length: N } ? A : Tuple<T, N, [...A, T]>;
-
-type Tuple20 = Tuple<number, 20>;
-
-func(tuple);
-
-const tuple2 = tuple3;
-// const tuple5: [number, number, number | undefined] = tuple3;
-
-type Tuple3 = typeof tuple3;
-type Tuple3Length = Tuple3["length"];
-
-function func2<T extends number[]>(
-  nums: T & (number extends T["length"] ? unknown : never)
-) {
-    console.log(nums);
-}
-
-// func2(tuple3);

package/migration-guide-template.md

@@ -1,3 +0,0 @@
-## [0.1.x to 0.2.0](https://github.com/OfficialHalfwayDead/assertie/compare/v0.1.0...v0.2.0)
-
-* Change all calls to `assertTypeof<<Something>>` to `assertTypeOf<<Something>>` (capitalization change for consistency).