get-or-throw 1.1.0 → 1.2.0

package/README.md

@@ -3,6 +3,13 @@
 A convenience function for adhering to Typescript's `noUncheckedIndexedAccess`
 setting.
 
+## Features
+
+- Uses Typescript assertions for type narrowing.
+- Works with both objects and arrays.
+- Supports negative indexing for arrays.
+- Allows for custom error messages.
+
 ## Installation
 
 ```bash
@@ -17,6 +24,10 @@ pnpm add get-or-throw
 const arr = [1, 2, 3];
 console.log(getOrThrow(arr, 1)); // Output: 2
 
+/** Support for negative indexing */
+const arr = [1, 2, 3];
+console.log(getOrThrow(arr, -1)); // Output: 3
+
 /** This will throw an error: "Index 3 is out of bounds." */
 console.log(getOrThrow(arr, 3));
 

package/dist/index.cjs

@@ -27,8 +27,13 @@ module.exports = __toCommonJS(src_exports);
 // src/get-or-throw.ts
 function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
   if (Array.isArray(objOrArr)) {
-    if (keyOrIndex in objOrArr) {
-      return objOrArr[keyOrIndex];
+    const length = objOrArr.length;
+    let index = keyOrIndex;
+    if (index < 0) {
+      index = length + index;
+    }
+    if (index >= 0 && index < length) {
+      return objOrArr[index];
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`

package/dist/index.d.cts

@@ -8,7 +8,6 @@
  * @returns The value at the given key or index.
  * @throws An error if the key or index does not exist.
  */
-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 | T[], keyOrIndex: K | number, errorMessage?: string): T[K] | T;
 
 export { getOrThrow };

package/dist/index.d.ts

@@ -8,7 +8,6 @@
  * @returns The value at the given key or index.
  * @throws An error if the key or index does not exist.
  */
-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 | T[], keyOrIndex: K | number, errorMessage?: string): T[K] | T;
 
 export { getOrThrow };

package/dist/index.js

@@ -1,8 +1,13 @@
 // src/get-or-throw.ts
 function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
   if (Array.isArray(objOrArr)) {
-    if (keyOrIndex in objOrArr) {
-      return objOrArr[keyOrIndex];
+    const length = objOrArr.length;
+    let index = keyOrIndex;
+    if (index < 0) {
+      index = length + index;
+    }
+    if (index >= 0 && index < length) {
+      return objOrArr[index];
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-or-throw",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A convenience function for adhering to Typescript's noUncheckedIndexedAccess rule",
   "type": "module",
   "main": "dist/index.cjs",

package/src/get-or-throw.ts

@@ -8,24 +8,22 @@
  * @returns The value at the given key or index.
  * @throws An error if the key or index does not exist.
  */
-export function getOrThrow<T extends object, K extends keyof T>(
-  obj: T,
-  key: K,
-  errorMessage?: string
-): T[K];
-export function getOrThrow<T>(
-  arr: T[],
-  index: number,
-  errorMessage?: string
-): T;
 export function getOrThrow<T extends object, K extends keyof T>(
   objOrArr: T | T[],
   keyOrIndex: K | number,
   errorMessage?: string
 ): T[K] | T {
   if (Array.isArray(objOrArr)) {
-    if (keyOrIndex in objOrArr) {
-      return objOrArr[keyOrIndex as number]!;
+    const length = objOrArr.length;
+    let index = keyOrIndex as number;
+
+    // Handle negative indexing
+    if (index < 0) {
+      index = length + index;
+    }
+
+    if (index >= 0 && index < length) {
+      return objOrArr[index]!;
     } else {
       throw new Error(
         errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`