get-or-throw 1.2.1 → 1.4.0

package/README.md

@@ -3,6 +3,10 @@
 A convenience function for adhering to Typescript's `noUncheckedIndexedAccess`
 setting.
 
+Get a value from an object or array at the specified key or index. Throw an
+error if the key or index does not exist, or if the resulting value is undefined
+or null.
+
 ## Features
 
 - Uses Typescript assertions for type narrowing.
@@ -41,4 +45,16 @@ console.log(getOrThrow(obj, "d"));
 /** This will throw an error: "Failed to find d" */
 const key = "d";
 console.log(getOrThrow(obj, key, `Failed to find ${key}`));
+
+/** This will throw an error: "Value at index 1 is undefined or null." */
+const arr = [1, null, 3];
+console.log(getOrThrow(arr, 1));
+
+/** This will throw an error: "Value at index 1 is undefined or null." */
+const arr = [1, undefined, 3];
+console.log(getOrThrow(arr, 1));
+
+/** This will throw an error: "Value at key 'b' is undefined or null." */
+const obj = { a: 1, b: undefined, c: 3 };
+console.log(getOrThrow(obj, "b"));
 ```

package/dist/index.cjs

@@ -33,7 +33,18 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
       index = length + index;
     }
     if (index >= 0 && index < length) {
-      return objOrArr[index];
+      const value = objOrArr[index];
+      if (value !== void 0 && value !== null) {
+        return value;
+      } else 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.`
+        );
+      }
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`
@@ -41,7 +52,18 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
     }
   } else {
     if (keyOrIndex in objOrArr) {
-      return objOrArr[keyOrIndex];
+      const value = objOrArr[keyOrIndex];
+      if (value !== void 0 && value !== null) {
+        return value;
+      } else 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.`
+        );
+      }
     } else {
       throw new Error(
         errorMessage ?? `Key "${String(keyOrIndex)}" does not exist in the object.`

package/dist/index.d.cts

@@ -1,14 +1,16 @@
 /**
- * Get a value from an object or array, or throw an error if the key or index
- * does not exist.
+ * 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.
  *
  * @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.
- * @throws An error if the key or index does not exist.
+ * @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.
  */
-declare function getOrThrow<T extends object, K extends keyof T>(obj: T, key: K, errorMessage?: string): T[K];
-declare function getOrThrow<T>(arr: T[], index: number, errorMessage?: string): T;
+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>;
 
 export { getOrThrow };

package/dist/index.d.ts

@@ -1,14 +1,16 @@
 /**
- * Get a value from an object or array, or throw an error if the key or index
- * does not exist.
+ * 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.
  *
  * @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.
- * @throws An error if the key or index does not exist.
+ * @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.
  */
-declare function getOrThrow<T extends object, K extends keyof T>(obj: T, key: K, errorMessage?: string): T[K];
-declare function getOrThrow<T>(arr: T[], index: number, errorMessage?: string): T;
+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>;
 
 export { getOrThrow };

package/dist/index.js

@@ -7,7 +7,18 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
       index = length + index;
     }
     if (index >= 0 && index < length) {
-      return objOrArr[index];
+      const value = objOrArr[index];
+      if (value !== void 0 && value !== null) {
+        return value;
+      } else 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.`
+        );
+      }
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`
@@ -15,7 +26,18 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
     }
   } else {
     if (keyOrIndex in objOrArr) {
-      return objOrArr[keyOrIndex];
+      const value = objOrArr[keyOrIndex];
+      if (value !== void 0 && value !== null) {
+        return value;
+      } else 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.`
+        );
+      }
     } 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.2.1",
+  "version": "1.4.0",
   "description": "A convenience function for adhering to Typescript's noUncheckedIndexedAccess rule",
   "type": "module",
   "main": "dist/index.cjs",
@@ -28,7 +28,8 @@
   },
   "homepage": "https://github.com/0x80/get-or-throw#readme",
   "devDependencies": {
-    "@codecompose/typescript-config": "^1.0.5",
+    "@codecompose/typescript-config": "^1.1.2",
+    "del-cli": "^5.1.0",
     "prettier": "^3.3.3",
     "prettier-plugin-jsdoc": "^1.3.0",
     "tsup": "^8.3.0",
@@ -36,6 +37,7 @@
   },
   "scripts": {
     "build": "tsup",
+    "clean": "del dist tsconfig.tsbuildinfo",
     "test": "echo \"Error: no test specified\" && exit 1"
   }
 }

package/src/get-or-throw.ts

@@ -1,39 +1,53 @@
 /**
- * Get a value from an object or array, or throw an error if the key or index
- * does not exist.
+ * 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.
  *
  * @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.
- * @throws An error if the key or index does not exist.
+ * @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.
  */
 export function getOrThrow<T extends object, K extends keyof T>(
-  obj: T,
-  key: K,
+  objOrArr: T,
+  keyOrIndex: K,
   errorMessage?: string
-): T[K];
+): NonNullable<T[K]>;
 export function getOrThrow<T>(
-  arr: T[],
-  index: number,
+  objOrArr: T[],
+  keyOrIndex: number,
   errorMessage?: string
-): T;
+): NonNullable<T>;
 export function getOrThrow<T extends object, K extends keyof T>(
   objOrArr: T | T[],
   keyOrIndex: K | number,
   errorMessage?: string
-): T[K] | T {
+): NonNullable<T[K]> | NonNullable<T> {
   if (Array.isArray(objOrArr)) {
     const length = objOrArr.length;
     let index = keyOrIndex as number;
 
-    // Handle negative indexing
+    /** Allow for negative indexing. */
     if (index < 0) {
       index = length + index;
     }
 
     if (index >= 0 && index < length) {
-      return objOrArr[index]!;
+      const value = objOrArr[index];
+
+      if (value !== undefined && value !== null) {
+        return value as NonNullable<T>;
+      } else 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.`
+        );
+      }
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`
@@ -41,7 +55,19 @@ export function getOrThrow<T extends object, K extends keyof T>(
     }
   } else {
     if (keyOrIndex in objOrArr) {
-      return objOrArr[keyOrIndex as K];
+      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 {
+        throw new Error(
+          errorMessage ?? `Value at key "${String(keyOrIndex)}" is null.`
+        );
+      }
     } else {
       throw new Error(
         errorMessage ??

package/tsconfig.json

@@ -1,7 +1,3 @@
 {
-  "extends": "@codecompose/typescript-config/library.json",
-  "compilerOptions": {
-    "composite": false,
-    "incremental": false
-  }
+  "extends": "@codecompose/typescript-config/single-library.json"
 }