get-or-throw 2.0.0 → 2.1.0

package/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
+    branches: ["**"]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

package/README.md

@@ -68,83 +68,3 @@ const value = got(obj, "b"); // Output: null
 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.d.cts

@@ -9,7 +9,7 @@
  * @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, keyOrIndex: K, errorMessage?: string): T[K];
+declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T, keyOrIndex: K, errorMessage?: string): NonNullable<T[K]>;
 declare function getOrThrow<T>(objOrArr: T[], keyOrIndex: number, errorMessage?: string): T;
 
 export { getOrThrow, getOrThrow as got };

package/dist/index.d.ts

@@ -9,7 +9,7 @@
  * @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, keyOrIndex: K, errorMessage?: string): T[K];
+declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T, keyOrIndex: K, errorMessage?: string): NonNullable<T[K]>;
 declare function getOrThrow<T>(objOrArr: T[], keyOrIndex: number, errorMessage?: string): T;
 
 export { getOrThrow, getOrThrow as got };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-or-throw",
-  "version": "2.0.0",
+  "version": "2.1.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.ts

@@ -13,7 +13,7 @@ export function getOrThrow<T extends object, K extends keyof T>(
   objOrArr: T,
   keyOrIndex: K,
   errorMessage?: string,
-): T[K];
+): NonNullable<T[K]>;
 export function getOrThrow<T>(
   objOrArr: T[],
   keyOrIndex: number,