get-or-throw 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Thijs Koerselman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# get-or-throw
+
+A convenience function for adhering to Typescript's `noUncheckedIndexedAccess` setting.
+
+## Installation
+
+```bash
+pnpm add get-or-throw
+```
+
+...or use the equivalent for your package manager.
+
+## Usage
+
+```ts
+const arr = [1, 2, 3];
+console.log(getOrThrow(arr, 1)); // Output: 2
+
+/** This will throw an error: "Index 3 is out of bounds." */
+console.log(getOrThrow(arr, 3));
+
+const obj = { a: 1, b: 2, c: 3 };
+console.log(getOrThrow(obj, "b")); // Output: 2
+
+/** This will throw an error: "Key "d" does not exist in the object." */
+console.log(getOrThrow(obj, "d"));
+```

package/dist/index.cjs

@@ -0,0 +1,48 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  getOrThrow: () => getOrThrow
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/get-or-throw.ts
+function getOrThrow(objOrArr, keyOrIndex) {
+  if (Array.isArray(objOrArr)) {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex];
+    } else {
+      throw new Error(`Index ${String(keyOrIndex)} is out of bounds.`);
+    }
+  } else {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex];
+    } else {
+      throw new Error(
+        `Key "${String(keyOrIndex)}" does not exist in the object.`
+      );
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getOrThrow
+});

package/dist/index.d.cts

@@ -0,0 +1,11 @@
+/**
+ * Get a value from an object or array, or throw an error if the key or index does not exist.
+ * @param objOrArr The object or array to get the value from.
+ * @param keyOrIndex The key or index to get the value from.
+ * @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): T[K];
+declare function getOrThrow<T>(arr: T[], index: number): T;
+
+export { getOrThrow };

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Get a value from an object or array, or throw an error if the key or index does not exist.
+ * @param objOrArr The object or array to get the value from.
+ * @param keyOrIndex The key or index to get the value from.
+ * @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): T[K];
+declare function getOrThrow<T>(arr: T[], index: number): T;
+
+export { getOrThrow };

package/dist/index.js

@@ -0,0 +1,21 @@
+// src/get-or-throw.ts
+function getOrThrow(objOrArr, keyOrIndex) {
+  if (Array.isArray(objOrArr)) {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex];
+    } else {
+      throw new Error(`Index ${String(keyOrIndex)} is out of bounds.`);
+    }
+  } else {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex];
+    } else {
+      throw new Error(
+        `Key "${String(keyOrIndex)}" does not exist in the object.`
+      );
+    }
+  }
+}
+export {
+  getOrThrow
+};

package/dist/index.mjs

@@ -0,0 +1,21 @@
+// src/get-or-throw.ts
+function getOrThrow(objOrArr, keyOrIndex) {
+  if (Array.isArray(objOrArr)) {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex];
+    } else {
+      throw new Error(`Index ${String(keyOrIndex)} is out of bounds.`);
+    }
+  } else {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex];
+    } else {
+      throw new Error(
+        `Key "${String(keyOrIndex)}" does not exist in the object.`
+      );
+    }
+  }
+}
+export {
+  getOrThrow
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "get-or-throw",
+  "version": "1.0.0",
+  "description": "A convenience function for adhering to TS noUncheckedIndexedAccess",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0x80/get-or-throw.git"
+  },
+  "keywords": [
+    "noUncheckedIndexedAccess"
+  ],
+  "author": "Thijs Koerselman",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/0x80/get-or-throw/issues"
+  },
+  "homepage": "https://github.com/0x80/get-or-throw#readme",
+  "devDependencies": {
+    "@codecompose/typescript-config": "^1.0.5",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.2"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/src/get-or-throw.ts

@@ -0,0 +1,32 @@
+/**
+ * Get a value from an object or array, or throw an error if the key or index does not exist.
+ * @param objOrArr The object or array to get the value from.
+ * @param keyOrIndex The key or index to get the value from.
+ * @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
+): T[K];
+export function getOrThrow<T>(arr: T[], index: number): T;
+export function getOrThrow<T extends object, K extends keyof T>(
+  objOrArr: T | T[],
+  keyOrIndex: K | number
+): T[K] | T {
+  if (Array.isArray(objOrArr)) {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex as number]!;
+    } else {
+      throw new Error(`Index ${String(keyOrIndex)} is out of bounds.`);
+    }
+  } else {
+    if (keyOrIndex in objOrArr) {
+      return objOrArr[keyOrIndex as K];
+    } else {
+      throw new Error(
+        `Key "${String(keyOrIndex)}" does not exist in the object.`
+      );
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./get-or-throw";

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@codecompose/typescript-config/library.json",
+  "compilerOptions": {
+    "composite": false,
+    "incremental": false
+  },
+  "include": ["src"]
+}

package/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["esm", "cjs"],
+  target: "node18",
+  dts: true,
+});