get-or-throw 1.5.0 → 2.0.0

package/.github/workflows/CODEOWNERS

@@ -0,0 +1 @@
+* @0x80

package/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        command: [lint, type-check, test]
+
+    name: ${{ matrix.command }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Enable corepack
+        run: corepack enable pnpm
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          # First tries exact match with lock file hash. If not found,
+          # falls back to any cache starting with 'pnpm-store-'.
+          # This way we get exact cache on repeated runs, but can still
+          # use older cache as starting point when dependencies change.
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run ${{ matrix.command }}
+        run: pnpm ${{ matrix.command }}

package/.prettierignore

@@ -0,0 +1 @@
+*.yml

package/.prettierrc.json

@@ -1,5 +1,4 @@
 {
-  "trailingComma": "es5",
   "proseWrap": "always",
   "plugins": ["./node_modules/prettier-plugin-jsdoc/dist/index.js"]
 }

package/README.md

@@ -1,9 +1,9 @@
-# get-or-throw
+# Get-Or-Throw / Got
 
-A simple convenience function for safely accessing values in objects and arrays.
-It gets a value from an object or array at a specified key or index, and throw
-an error if the resulting value is `undefined` or `null`. Optionally, you can
-set custom error message.
+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`. 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)
@@ -11,7 +11,7 @@ setting, which is recommended for strict type checking.
 
 ## Features
 
-- Uses Typescript assertions for type narrowing.
+- Typescript assertions for type narrowing.
 - Works with both objects and arrays.
 - Supports negative indexing for arrays.
 - Allows for custom error messages.
@@ -28,38 +28,123 @@ pnpm add get-or-throw
 
 ## Usage
 
+The example code below uses the `got` alias but `getOrThrow` is also available
+if you want to be more explicit.
+
 ```ts
 const arr = [1, 2, 3];
-console.log(getOrThrow(arr, 1)); // Output: 2
+const value = got(arr, 1); // Output: 2
 
 /** Support for negative indexing */
 const arr = [1, 2, 3];
-console.log(getOrThrow(arr, -1)); // Output: 3
+const value = got(arr, -1); // Output: 3
 
 /** This will throw an error: "Index 3 is out of bounds." */
-console.log(getOrThrow(arr, 3));
+const value = got(arr, 3);
 
 const obj = { a: 1, b: 2, c: 3 };
-console.log(getOrThrow(obj, "b")); // Output: 2
+const value = got(obj, "b"); // Output: 2
 
 /** This will throw an error: "Key "d" does not exist in the object." */
-console.log(getOrThrow(obj, "d"));
+const value = got(obj, "d");
 
 /** This will throw an error: "Failed to find d" */
 const key = "d";
-console.log(getOrThrow(obj, key, `Failed to find ${key}`));
+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];
-console.log(getOrThrow(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];
-console.log(getOrThrow(arr, 1));
+const value = got(arr, 1);
+
+/** 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 or null." */
+/** This will throw an error: "Value at key 'b' is undefined." */
 const obj = { a: 1, b: undefined, c: 3 };
-console.log(getOrThrow(obj, "b"));
+const value = got(obj, "b");
 ```
 
-## Alias
+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

@@ -35,17 +35,12 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
     }
     if (index >= 0 && index < length) {
       const value = objOrArr[index];
-      if (value !== void 0 && value !== null) {
-        return value;
-      } else if (value === void 0) {
+      if (value === void 0) {
         throw new Error(
           errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`
         );
-      } else {
-        throw new Error(
-          errorMessage ?? `Value at index ${String(keyOrIndex)} is null.`
-        );
       }
+      return value;
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`
@@ -54,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,16 +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, keyOrIndex: K, errorMessage?: string): NonNullable<T[K]>;
-declare function getOrThrow<T>(objOrArr: T[], keyOrIndex: number, errorMessage?: string): 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,16 +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, keyOrIndex: K, errorMessage?: string): NonNullable<T[K]>;
-declare function getOrThrow<T>(objOrArr: T[], keyOrIndex: number, errorMessage?: string): 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

@@ -8,17 +8,12 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
     }
     if (index >= 0 && index < length) {
       const value = objOrArr[index];
-      if (value !== void 0 && value !== null) {
-        return value;
-      } else if (value === void 0) {
+      if (value === void 0) {
         throw new Error(
           errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`
         );
-      } else {
-        throw new Error(
-          errorMessage ?? `Value at index ${String(keyOrIndex)} is null.`
-        );
       }
+      return value;
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`
@@ -27,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/eslint.config.js

@@ -0,0 +1,28 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  {
+    ignores: [
+      "dist/**",
+      "node_modules/**",
+      /**
+       * Ignore all config files int the root. We should instead solve this with
+       * projectService setting so that these files can also be linted, but
+       * let's get this to work first
+       */
+      "*.{js,ts}",
+    ],
+  },
+  eslint.configs.recommended,
+  tseslint.configs.strictTypeChecked,
+  tseslint.configs.stylisticTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "get-or-throw",
-  "version": "1.5.0",
-  "description": "A convenience function for adhering to Typescript's noUncheckedIndexedAccess rule",
+  "version": "2.0.0",
+  "description": "A convenience function for safely getting values from dynamic objects and arrays",
   "type": "module",
   "main": "dist/index.cjs",
   "types": "dist/index.d.ts",
@@ -29,15 +29,22 @@
   "homepage": "https://github.com/0x80/get-or-throw#readme",
   "devDependencies": {
     "@codecompose/typescript-config": "^1.1.2",
+    "@eslint/js": "^9.22.0",
     "del-cli": "^5.1.0",
+    "eslint": "^9.22.0",
     "prettier": "^3.3.3",
     "prettier-plugin-jsdoc": "^1.3.0",
     "tsup": "^8.3.0",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.2",
+    "typescript-eslint": "^8.26.0",
+    "vitest": "^3.0.8"
   },
   "scripts": {
     "build": "tsup",
     "clean": "del dist tsconfig.tsbuildinfo",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "lint": "eslint .",
+    "type-check": "tsc --noEmit",
+    "test": "vitest",
+    "format": "prettier --write ."
   }
 }

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

@@ -0,0 +1,70 @@
+import { describe, expect, it } from "vitest";
+import { getOrThrow, got } 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");
+    });
+  });
+});

package/src/get-or-throw.ts

@@ -1,30 +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,
   keyOrIndex: K,
-  errorMessage?: string
-): NonNullable<T[K]>;
+  errorMessage?: string,
+): T[K];
 export function getOrThrow<T>(
   objOrArr: T[],
   keyOrIndex: number,
-  errorMessage?: string
-): NonNullable<T>;
+  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> {
+  errorMessage?: string,
+): T[K] | T {
   if (Array.isArray(objOrArr)) {
     const length = objOrArr.length;
     let index = keyOrIndex as number;
@@ -37,41 +36,31 @@ export function getOrThrow<T extends object, K extends keyof T>(
     if (index >= 0 && index < length) {
       const value = objOrArr[index];
 
-      if (value !== undefined && value !== null) {
-        return value as NonNullable<T>;
-      } else if (value === undefined) {
+      if (value === undefined) {
         throw new Error(
-          errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`
-        );
-      } else {
-        throw new Error(
-          errorMessage ?? `Value at index ${String(keyOrIndex)} is null.`
+          errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`,
         );
       }
+      return value;
     } else {
       throw new Error(
-        errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`
+        errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`,
       );
     }
   } else {
     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) {
-        throw new Error(
-          errorMessage ?? `Value at key "${String(keyOrIndex)}" is undefined.`
-        );
-      } else {
+      if (value === undefined) {
         throw new Error(
-          errorMessage ?? `Value at key "${String(keyOrIndex)}" is null.`
+          errorMessage ?? `Value at key "${String(keyOrIndex)}" is undefined.`,
         );
       }
+      return value;
     } else {
       throw new Error(
         errorMessage ??
-          `Key "${String(keyOrIndex)}" does not exist in the object.`
+          `Key "${String(keyOrIndex)}" does not exist in the object.`,
       );
     }
   }

package/tsconfig.json

@@ -1,3 +1,6 @@
 {
-  "extends": "@codecompose/typescript-config/single-library.json"
+  "extends": "@codecompose/typescript-config/single-library.json",
+  "compilerOptions": {
+    "rootDir": "." // Needed for CI for some reason
+  }
 }