get-or-throw 1.5.1 → 2.0.0

package/.github/workflows/ci.yml

@@ -6,6 +6,10 @@ on:
   pull_request:
     branches: [main]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   verify:
     runs-on: ubuntu-latest
@@ -22,12 +26,10 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "22"
+          node-version: 22
 
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 8
+      - name: Enable corepack
+        run: corepack enable pnpm
 
       - name: Get pnpm store directory
         id: pnpm-cache
@@ -48,7 +50,7 @@ jobs:
             ${{ runner.os }}-pnpm-store-
 
       - name: Install dependencies
-        run: pnpm install
+        run: pnpm install --frozen-lockfile
 
       - name: Run ${{ matrix.command }}
         run: pnpm ${{ matrix.command }}

package/README.md

@@ -2,8 +2,8 @@
 
 A convenience function for safely accessing values in dynamic objects and
 arrays. It gets the value at a specified key or index, and throws an error if
-the resulting value is `undefined` or `null`. Optionally, you can set custom
-error message.
+the resulting value is `undefined`. Optionally, you can set a custom error
+message.
 
 This was created to make it easy to adhere to Typescript's
 [noUncheckedIndexedAccess](https://www.typescriptlang.org/tsconfig/#noUncheckedIndexedAccess)
@@ -52,15 +52,99 @@ const value = got(obj, "d");
 const key = "d";
 const value = got(obj, key, `Failed to find ${key}`);
 
-/** This will throw an error: "Value at index 1 is undefined or null." */
+/** Null is a valid value */
 const arr = [1, null, 3];
-const value = got(arr, 1);
+const value = got(arr, 1); // Output: null
 
-/** This will throw an error: "Value at index 1 is undefined or null." */
+/** This will throw an error: "Value at index 1 is undefined." */
 const arr = [1, undefined, 3];
 const value = got(arr, 1);
 
-/** This will throw an error: "Value at key 'b' is undefined or null." */
+/** Null is a valid value */
+const obj = { a: 1, b: null, c: 3 };
+const value = got(obj, "b"); // Output: null
+
+/** This will throw an error: "Value at key 'b' is undefined." */
 const obj = { a: 1, b: undefined, c: 3 };
 const value = got(obj, "b");
 ```
+
+And here's the updated test file:
+
+```typescript:src/get-or-throw.test.ts
+import { describe, it, expect } from 'vitest';
+import { got, getOrThrow } from './get-or-throw';
+
+describe('get-or-throw', () => {
+  describe('array access', () => {
+    it('should get value at positive index', () => {
+      const arr = [1, 2, 3];
+      expect(got(arr, 1)).toBe(2);
+      expect(getOrThrow(arr, 1)).toBe(2);
+    });
+
+    it('should support negative indexing', () => {
+      const arr = [1, 2, 3];
+      expect(got(arr, -1)).toBe(3);
+      expect(got(arr, -2)).toBe(2);
+    });
+
+    it('should throw on out of bounds index', () => {
+      const arr = [1, 2, 3];
+      expect(() => got(arr, 3)).toThrow('Index 3 is out of bounds.');
+    });
+
+    it('should allow null values', () => {
+      const arr = [1, null, 3];
+      expect(got(arr, 1)).toBeNull();
+    });
+
+    it('should throw on undefined values', () => {
+      const arr = [1, undefined, 3];
+      expect(() => got(arr, 1)).toThrow('Value at index 1 is undefined.');
+    });
+  });
+
+  describe('object access', () => {
+    it('should get value at existing key', () => {
+      const obj = { a: 1, b: 2, c: 3 };
+      expect(got(obj, 'b')).toBe(2);
+      expect(getOrThrow(obj, 'b')).toBe(2);
+    });
+
+    it('should throw on non-existent key', () => {
+      const obj = { a: 1, b: 2, c: 3 };
+      expect(() => got(obj, 'd' as keyof typeof obj)).toThrow(
+        'Key "d" does not exist in the object.'
+      );
+    });
+
+    it('should allow null values', () => {
+      const obj = { a: 1, b: null, c: 3 };
+      expect(got(obj, 'b')).toBeNull();
+    });
+
+    it('should throw on undefined values', () => {
+      const obj = { a: 1, b: undefined, c: 3 };
+      expect(() => got(obj, 'b')).toThrow('Value at key "b" is undefined.');
+    });
+  });
+
+  describe('custom error messages', () => {
+    it('should use custom error message when provided', () => {
+      const obj = { a: 1, b: 2, c: 3 };
+      const key = 'd';
+      expect(() => got(obj, key as keyof typeof obj, `Failed to find ${key}`)).toThrow(
+        'Failed to find d'
+      );
+    });
+  });
+});
+```
+
+The key changes:
+
+1. Updated documentation to clarify that only `undefined` values throw
+2. Added examples showing that `null` is now a valid value
+3. Updated tests to verify `null` values are allowed
+4. Renamed test cases to reflect the new behavior

package/dist/index.cjs

@@ -39,10 +39,6 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
         throw new Error(
           errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`
         );
-      } else if (value === null) {
-        throw new Error(
-          errorMessage ?? `Value at index ${String(keyOrIndex)} is null.`
-        );
       }
       return value;
     } else {
@@ -53,17 +49,12 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
   } else {
     if (keyOrIndex in objOrArr) {
       const value = objOrArr[keyOrIndex];
-      if (value !== void 0 && value !== null) {
-        return value;
-      } else if (value === void 0) {
+      if (value === void 0) {
         throw new Error(
           errorMessage ?? `Value at key "${String(keyOrIndex)}" is undefined.`
         );
-      } else {
-        throw new Error(
-          errorMessage ?? `Value at key "${String(keyOrIndex)}" is null.`
-        );
       }
+      return value;
     } else {
       throw new Error(
         errorMessage ?? `Key "${String(keyOrIndex)}" does not exist in the object.`

package/dist/index.d.cts

@@ -1,15 +1,15 @@
 /**
  * Get a value from an object or array, and throw an error if the key or index
- * does not exist or if the resulting value is undefined or null.
+ * does not exist or if the resulting value is undefined.
  *
  * @param objOrArr The object or array to get the value from.
  * @param keyOrIndex The key or index to get the value from.
  * @param errorMessage Optional error message to include in the error thrown.
- * @returns The value at the given key or index, guaranteed to be non-null and
- *   non-undefined.
- * @throws An error if the key or index does not exist, or if the resulting
- *   value is undefined or null.
+ * @returns The value at the given key or index, guaranteed to be defined.
+ * @throws An error if the key or index does not exist, or if the value is
+ *   undefined.
  */
-declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T | (T | null)[], keyOrIndex: K | number, errorMessage?: string): NonNullable<T[K]> | NonNullable<T>;
+declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T, keyOrIndex: K, errorMessage?: string): T[K];
+declare function getOrThrow<T>(objOrArr: T[], keyOrIndex: number, errorMessage?: string): T;
 
 export { getOrThrow, getOrThrow as got };

package/dist/index.d.ts

@@ -1,15 +1,15 @@
 /**
  * Get a value from an object or array, and throw an error if the key or index
- * does not exist or if the resulting value is undefined or null.
+ * does not exist or if the resulting value is undefined.
  *
  * @param objOrArr The object or array to get the value from.
  * @param keyOrIndex The key or index to get the value from.
  * @param errorMessage Optional error message to include in the error thrown.
- * @returns The value at the given key or index, guaranteed to be non-null and
- *   non-undefined.
- * @throws An error if the key or index does not exist, or if the resulting
- *   value is undefined or null.
+ * @returns The value at the given key or index, guaranteed to be defined.
+ * @throws An error if the key or index does not exist, or if the value is
+ *   undefined.
  */
-declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T | (T | null)[], keyOrIndex: K | number, errorMessage?: string): NonNullable<T[K]> | NonNullable<T>;
+declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T, keyOrIndex: K, errorMessage?: string): T[K];
+declare function getOrThrow<T>(objOrArr: T[], keyOrIndex: number, errorMessage?: string): T;
 
 export { getOrThrow, getOrThrow as got };

package/dist/index.js

@@ -12,10 +12,6 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
         throw new Error(
           errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`
         );
-      } else if (value === null) {
-        throw new Error(
-          errorMessage ?? `Value at index ${String(keyOrIndex)} is null.`
-        );
       }
       return value;
     } else {
@@ -26,17 +22,12 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
   } else {
     if (keyOrIndex in objOrArr) {
       const value = objOrArr[keyOrIndex];
-      if (value !== void 0 && value !== null) {
-        return value;
-      } else if (value === void 0) {
+      if (value === void 0) {
         throw new Error(
           errorMessage ?? `Value at key "${String(keyOrIndex)}" is undefined.`
         );
-      } else {
-        throw new Error(
-          errorMessage ?? `Value at key "${String(keyOrIndex)}" is null.`
-        );
       }
+      return value;
     } else {
       throw new Error(
         errorMessage ?? `Key "${String(keyOrIndex)}" does not exist in the object.`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-or-throw",
-  "version": "1.5.1",
+  "version": "2.0.0",
   "description": "A convenience function for safely getting values from dynamic objects and arrays",
   "type": "module",
   "main": "dist/index.cjs",

package/src/get-or-throw.test.ts

@@ -20,9 +20,9 @@ describe("get-or-throw", () => {
       expect(() => got(arr, 3)).toThrow("Index 3 is out of bounds.");
     });
 
-    it("should throw on null values", () => {
+    it("should allow null values", () => {
       const arr = [1, null, 3];
-      expect(() => got(arr, 1)).toThrow("Value at index 1 is null.");
+      expect(got(arr, 1)).toBeNull();
     });
 
     it("should throw on undefined values", () => {
@@ -45,14 +45,16 @@ describe("get-or-throw", () => {
       );
     });
 
-    it("should throw on null values", () => {
+    it("should allow null values", () => {
       const obj = { a: 1, b: null, c: 3 };
-      expect(() => got(obj, "b")).toThrow('Value at key "b" is null.');
+      expect(got(obj, "b")).toBeNull();
     });
 
     it("should throw on undefined values", () => {
       const obj = { a: 1, b: undefined, c: 3 };
-      expect(() => got(obj, "b")).toThrow('Value at key "b" is undefined.');
+      expect(() => {
+        got(obj, "b");
+      }).toThrow('Value at key "b" is undefined.');
     });
   });
 

package/src/get-or-throw.ts

@@ -1,20 +1,29 @@
 /**
  * Get a value from an object or array, and throw an error if the key or index
- * does not exist or if the resulting value is undefined or null.
+ * does not exist or if the resulting value is undefined.
  *
  * @param objOrArr The object or array to get the value from.
  * @param keyOrIndex The key or index to get the value from.
  * @param errorMessage Optional error message to include in the error thrown.
- * @returns The value at the given key or index, guaranteed to be non-null and
- *   non-undefined.
- * @throws An error if the key or index does not exist, or if the resulting
- *   value is undefined or null.
+ * @returns The value at the given key or index, guaranteed to be defined.
+ * @throws An error if the key or index does not exist, or if the value is
+ *   undefined.
  */
 export function getOrThrow<T extends object, K extends keyof T>(
-  objOrArr: T | (T | null)[],
+  objOrArr: T,
+  keyOrIndex: K,
+  errorMessage?: string,
+): T[K];
+export function getOrThrow<T>(
+  objOrArr: T[],
+  keyOrIndex: number,
+  errorMessage?: string,
+): T;
+export function getOrThrow<T extends object, K extends keyof T>(
+  objOrArr: T | T[],
   keyOrIndex: K | number,
   errorMessage?: string,
-): NonNullable<T[K]> | NonNullable<T> {
+): T[K] | T {
   if (Array.isArray(objOrArr)) {
     const length = objOrArr.length;
     let index = keyOrIndex as number;
@@ -31,10 +40,6 @@ export function getOrThrow<T extends object, K extends keyof T>(
         throw new Error(
           errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`,
         );
-      } else if (value === null) {
-        throw new Error(
-          errorMessage ?? `Value at index ${String(keyOrIndex)} is null.`,
-        );
       }
       return value;
     } else {
@@ -46,17 +51,12 @@ export function getOrThrow<T extends object, K extends keyof T>(
     if (keyOrIndex in objOrArr) {
       const value = objOrArr[keyOrIndex as K];
 
-      if (value !== undefined && value !== null) {
-        return value as NonNullable<T[K]>;
-      } else if (value === undefined) {
+      if (value === undefined) {
         throw new Error(
           errorMessage ?? `Value at key "${String(keyOrIndex)}" is undefined.`,
         );
-      } else {
-        throw new Error(
-          errorMessage ?? `Value at key "${String(keyOrIndex)}" is null.`,
-        );
       }
+      return value;
     } else {
       throw new Error(
         errorMessage ??