get-or-throw 2.2.0 → 2.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-or-throw",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "A convenience function for safely getting values from dynamic objects and arrays",
   "keywords": [
     "indexed",
@@ -19,12 +19,18 @@
     "url": "git+https://github.com/0x80/get-or-throw.git"
   },
   "type": "module",
-  "main": "dist/index.cjs",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
   "publishConfig": {
@@ -45,16 +51,16 @@
     "docs:preview": "vitepress preview docs"
   },
   "devDependencies": {
-    "@codecompose/typescript-config": "^3.0.0",
-    "del-cli": "^5.1.0",
-    "oxfmt": "^0.33.0",
-    "oxlint": "^1.48.0",
-    "oxlint-tsgolint": "^0.15.0",
-    "tsdown": "^0.12.0",
-    "typescript": "6.0.0-beta",
-    "vite": "^6.0.0",
+    "@codecompose/typescript-config": "^3.1.0",
+    "del-cli": "^7.0.0",
+    "oxfmt": "^0.43.0",
+    "oxlint": "^1.58.0",
+    "oxlint-tsgolint": "^0.20.0",
+    "tsdown": "^0.21.7",
+    "typescript": "6.0.2",
+    "vite": "^8.0.5",
     "vitepress": "^1.6.0",
-    "vitest": "^3.0.8"
+    "vitest": "^4.1.2"
   },
   "engines": {
     "node": ">=22.12.0"

package/dist/index-CLvtl5bd.d.ts

@@ -1,19 +0,0 @@
-//#region src/get-or-throw.d.ts
-/**
- * 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.
- *
- * @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 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): T;
-/** Export the same function under the alias 'got' */
-
-//#endregion
-export { getOrThrow, getOrThrow as got };
-//# sourceMappingURL=index-CLvtl5bd.d.ts.map

package/dist/index-CRoiksIS.d.cts

@@ -1,19 +0,0 @@
-//#region src/get-or-throw.d.ts
-/**
- * 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.
- *
- * @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 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): T;
-/** Export the same function under the alias 'got' */
-
-//#endregion
-export { getOrThrow, getOrThrow as got };
-//# sourceMappingURL=index-CRoiksIS.d.cts.map

package/dist/index.cjs

@@ -1,24 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region src/get-or-throw.ts
-function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
-	if (Array.isArray(objOrArr)) {
-		const length = objOrArr.length;
-		let index = keyOrIndex;
-		/** Allow for negative indexing. */
-		if (index < 0) index = length + index;
-		if (index >= 0 && index < length) {
-			const value = objOrArr[index];
-			if (value === void 0) throw new Error(errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`);
-			return value;
-		} else throw new Error(errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`);
-	} else if (keyOrIndex in objOrArr) {
-		const value = objOrArr[keyOrIndex];
-		if (value === void 0) throw new Error(errorMessage ?? `Value at key "${String(keyOrIndex)}" is undefined.`);
-		return value;
-	} else throw new Error(errorMessage ?? `Key "${String(keyOrIndex)}" does not exist in the object.`);
-}
-//#endregion
-exports.getOrThrow = getOrThrow;
-exports.got = getOrThrow;
-
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","names":[],"sources":["../src/get-or-throw.ts"],"sourcesContent":["/**\n * Get a value from an object or array, and throw an error if the key or index\n * does not exist or if the resulting value is undefined.\n *\n * @param objOrArr The object or array to get the value from.\n * @param keyOrIndex The key or index to get the value from.\n * @param errorMessage Optional error message to include in the error thrown.\n * @returns The value at the given key or index, guaranteed to be defined.\n * @throws An error if the key or index does not exist, or if the value is\n *   undefined.\n */\nexport function getOrThrow<T extends object, K extends keyof T>(\n  objOrArr: T,\n  keyOrIndex: K,\n  errorMessage?: string,\n): NonNullable<T[K]>;\nexport function getOrThrow<T>(\n  objOrArr: T[],\n  keyOrIndex: number,\n  errorMessage?: string,\n): T;\nexport function getOrThrow<T extends object, K extends keyof T>(\n  objOrArr: T | T[],\n  keyOrIndex: K | number,\n  errorMessage?: string,\n): T[K] | T {\n  if (Array.isArray(objOrArr)) {\n    const length = objOrArr.length;\n    let index = keyOrIndex as number;\n\n    /** Allow for negative indexing. */\n    if (index < 0) {\n      index = length + index;\n    }\n\n    if (index >= 0 && index < length) {\n      const value = objOrArr[index];\n\n      if (value === undefined) {\n        throw new Error(\n          errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`,\n        );\n      }\n      return value;\n    } else {\n      throw new Error(\n        errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`,\n      );\n    }\n  } else {\n    if (keyOrIndex in objOrArr) {\n      const value = objOrArr[keyOrIndex as K];\n\n      if (value === undefined) {\n        throw new Error(\n          errorMessage ?? `Value at key \"${String(keyOrIndex)}\" is undefined.`,\n        );\n      }\n      return value;\n    } else {\n      throw new Error(\n        errorMessage ??\n          `Key \"${String(keyOrIndex)}\" does not exist in the object.`,\n      );\n    }\n  }\n}\n\n/** Export the same function under the alias 'got' */\nexport { getOrThrow as got };\n"],"mappings":";;AAqBA,SAAgB,WACd,UACA,YACA,cACU;AACV,KAAI,MAAM,QAAQ,SAAS,EAAE;EAC3B,MAAM,SAAS,SAAS;EACxB,IAAI,QAAQ;;AAGZ,MAAI,QAAQ,EACV,SAAQ,SAAS;AAGnB,MAAI,SAAS,KAAK,QAAQ,QAAQ;GAChC,MAAM,QAAQ,SAAS;AAEvB,OAAI,UAAU,KAAA,EACZ,OAAM,IAAI,MACR,gBAAgB,kBAAkB,OAAO,WAAW,CAAC,gBACtD;AAEH,UAAO;QAEP,OAAM,IAAI,MACR,gBAAgB,SAAS,OAAO,WAAW,CAAC,oBAC7C;YAGC,cAAc,UAAU;EAC1B,MAAM,QAAQ,SAAS;AAEvB,MAAI,UAAU,KAAA,EACZ,OAAM,IAAI,MACR,gBAAgB,iBAAiB,OAAO,WAAW,CAAC,iBACrD;AAEH,SAAO;OAEP,OAAM,IAAI,MACR,gBACE,QAAQ,OAAO,WAAW,CAAC,iCAC9B"}

package/dist/index.js

@@ -1,22 +0,0 @@
-//#region src/get-or-throw.ts
-function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
-	if (Array.isArray(objOrArr)) {
-		const length = objOrArr.length;
-		let index = keyOrIndex;
-		/** Allow for negative indexing. */
-		if (index < 0) index = length + index;
-		if (index >= 0 && index < length) {
-			const value = objOrArr[index];
-			if (value === void 0) throw new Error(errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`);
-			return value;
-		} else throw new Error(errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`);
-	} else if (keyOrIndex in objOrArr) {
-		const value = objOrArr[keyOrIndex];
-		if (value === void 0) throw new Error(errorMessage ?? `Value at key "${String(keyOrIndex)}" is undefined.`);
-		return value;
-	} else throw new Error(errorMessage ?? `Key "${String(keyOrIndex)}" does not exist in the object.`);
-}
-//#endregion
-export { getOrThrow, getOrThrow as got };
-
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/get-or-throw.ts"],"sourcesContent":["/**\n * Get a value from an object or array, and throw an error if the key or index\n * does not exist or if the resulting value is undefined.\n *\n * @param objOrArr The object or array to get the value from.\n * @param keyOrIndex The key or index to get the value from.\n * @param errorMessage Optional error message to include in the error thrown.\n * @returns The value at the given key or index, guaranteed to be defined.\n * @throws An error if the key or index does not exist, or if the value is\n *   undefined.\n */\nexport function getOrThrow<T extends object, K extends keyof T>(\n  objOrArr: T,\n  keyOrIndex: K,\n  errorMessage?: string,\n): NonNullable<T[K]>;\nexport function getOrThrow<T>(\n  objOrArr: T[],\n  keyOrIndex: number,\n  errorMessage?: string,\n): T;\nexport function getOrThrow<T extends object, K extends keyof T>(\n  objOrArr: T | T[],\n  keyOrIndex: K | number,\n  errorMessage?: string,\n): T[K] | T {\n  if (Array.isArray(objOrArr)) {\n    const length = objOrArr.length;\n    let index = keyOrIndex as number;\n\n    /** Allow for negative indexing. */\n    if (index < 0) {\n      index = length + index;\n    }\n\n    if (index >= 0 && index < length) {\n      const value = objOrArr[index];\n\n      if (value === undefined) {\n        throw new Error(\n          errorMessage ?? `Value at index ${String(keyOrIndex)} is undefined.`,\n        );\n      }\n      return value;\n    } else {\n      throw new Error(\n        errorMessage ?? `Index ${String(keyOrIndex)} is out of bounds.`,\n      );\n    }\n  } else {\n    if (keyOrIndex in objOrArr) {\n      const value = objOrArr[keyOrIndex as K];\n\n      if (value === undefined) {\n        throw new Error(\n          errorMessage ?? `Value at key \"${String(keyOrIndex)}\" is undefined.`,\n        );\n      }\n      return value;\n    } else {\n      throw new Error(\n        errorMessage ??\n          `Key \"${String(keyOrIndex)}\" does not exist in the object.`,\n      );\n    }\n  }\n}\n\n/** Export the same function under the alias 'got' */\nexport { getOrThrow as got };\n"],"mappings":";AAqBA,SAAgB,WACd,UACA,YACA,cACU;AACV,KAAI,MAAM,QAAQ,SAAS,EAAE;EAC3B,MAAM,SAAS,SAAS;EACxB,IAAI,QAAQ;;AAGZ,MAAI,QAAQ,EACV,SAAQ,SAAS;AAGnB,MAAI,SAAS,KAAK,QAAQ,QAAQ;GAChC,MAAM,QAAQ,SAAS;AAEvB,OAAI,UAAU,KAAA,EACZ,OAAM,IAAI,MACR,gBAAgB,kBAAkB,OAAO,WAAW,CAAC,gBACtD;AAEH,UAAO;QAEP,OAAM,IAAI,MACR,gBAAgB,SAAS,OAAO,WAAW,CAAC,oBAC7C;YAGC,cAAc,UAAU;EAC1B,MAAM,QAAQ,SAAS;AAEvB,MAAI,UAAU,KAAA,EACZ,OAAM,IAAI,MACR,gBAAgB,iBAAiB,OAAO,WAAW,CAAC,iBACrD;AAEH,SAAO;OAEP,OAAM,IAAI,MACR,gBACE,QAAQ,OAAO,WAAW,CAAC,iCAC9B"}