get-or-throw 2.1.0 → 2.2.0

package/.editorconfig

@@ -0,0 +1,33 @@
+# Defines the coding style for different editors and IDEs.
+# https://editorconfig.org/
+
+# top-most EditorConfig file
+root = true
+
+# Rules for source code.
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+max_line_length = 80
+
+[*.{py,pyi}]
+indent_size = 4
+
+# Documentation.
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+# Git commit messages.
+[COMMIT_EDITMSG]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+# Makefiles require tabs.
+[Makefile]
+indent_style = tab
+indent_size = 8

package/.github/workflows/{ci.yml → checks.yml}

@@ -1,13 +1,18 @@
-name: CI
+name: Checks
 
 on:
   push:
     branches: [main]
   pull_request:
     branches: ["**"]
+  workflow_call:
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  # Skip concurrency restriction when called from another workflow
+  # This prevents deadlocks between parent workflow and this one
+  group:
+    ${{ github.event_name == 'workflow_call' && format('{0}-{1}', github.workflow,
+    github.run_id) || format('{0}-{1}', github.workflow, github.ref) }}
   cancel-in-progress: true
 
 jobs:
@@ -16,8 +21,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        command: [lint, type-check, test]
-
+        command: [check-types, check-format, check-lint, test]
     name: ${{ matrix.command }}
 
     steps:
@@ -26,7 +30,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 22
+          node-version: 24
 
       - name: Enable corepack
         run: corepack enable pnpm
@@ -42,15 +46,14 @@ jobs:
         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: Build
+        run: pnpm build
+
       - name: Run ${{ matrix.command }}
         run: pnpm ${{ matrix.command }}

package/.github/workflows/docs.yml

@@ -0,0 +1,74 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "package.json"
+      - "pnpm-lock.yaml"
+      - ".github/workflows/docs.yml"
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+
+      - 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') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build docs
+        run: pnpm docs:build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.github/workflows/publish.yml

@@ -0,0 +1,157 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: "Version bump type"
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+          - prepatch
+          - preminor
+          - premajor
+          - prerelease
+      preid:
+        description: "Prerelease identifier (alpha, beta, rc). Only used with pre* bumps."
+        required: false
+        type: string
+      explicit_version:
+        description: "Explicit version (e.g. 2.0.0-beta.1). Overrides bump and preid when set."
+        required: false
+        type: string
+      dry_run:
+        description: "Dry run — skip publish, push, and release"
+        required: false
+        type: boolean
+        default: false
+
+concurrency:
+  group: publish
+  cancel-in-progress: false
+
+jobs:
+  checks:
+    if: github.ref == 'refs/heads/main' || startsWith(inputs.bump, 'pre') || inputs.explicit_version != ''
+    uses: ./.github/workflows/checks.yml
+
+  publish:
+    if: github.ref == 'refs/heads/main' || startsWith(inputs.bump, 'pre') || inputs.explicit_version != ''
+    needs: checks
+    runs-on: ubuntu-latest
+    # Authentication is handled via OIDC trusted publishing (id-token),
+    # so no NPM_TOKEN secret is needed.
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          registry-url: "https://registry.npmjs.org"
+
+      - 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') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm build
+
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Bump version
+        id: version
+        env:
+          BUMP: ${{ inputs.bump }}
+          PREID: ${{ inputs.preid }}
+          EXPLICIT_VERSION: ${{ inputs.explicit_version }}
+        run: |
+          if [[ -n "$EXPLICIT_VERSION" ]]; then
+            npm version "$EXPLICIT_VERSION" --git-tag-version true
+          else
+            ARGS=("$BUMP")
+            if [[ "$BUMP" == pre* && -n "$PREID" ]]; then
+              ARGS+=(--preid "$PREID")
+            fi
+            npm version "${ARGS[@]}" --git-tag-version true
+          fi
+
+          VERSION=$(node -p "require('./package.json').version")
+          TAG="v${VERSION}"
+
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          echo "tag=${TAG}" >> $GITHUB_OUTPUT
+
+          if [[ "$VERSION" == *-* ]]; then
+            echo "dist_tag=next" >> $GITHUB_OUTPUT
+            echo "prerelease=true" >> $GITHUB_OUTPUT
+          else
+            echo "dist_tag=latest" >> $GITHUB_OUTPUT
+            echo "prerelease=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish summary
+        run: |
+          echo "### Publish Summary" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "- **Version:** ${{ steps.version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Tag:** ${{ steps.version.outputs.tag }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Dist tag:** ${{ steps.version.outputs.dist_tag }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Prerelease:** ${{ steps.version.outputs.prerelease }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Dry run:** ${{ inputs.dry_run }}" >> $GITHUB_STEP_SUMMARY
+
+      # Publish before push: npm publish is not retryable (same version
+      # can't be published twice), while git push is idempotent. If push
+      # fails after a successful publish, it can simply be retried manually.
+      - name: Publish to npm
+        if: ${{ inputs.dry_run == false }}
+        run: |
+          npm publish --provenance --tag ${{ steps.version.outputs.dist_tag }}
+
+      - name: Push version commit
+        if: ${{ inputs.dry_run == false }}
+        run: git push origin HEAD
+
+      - name: Push version tag
+        if: ${{ inputs.dry_run == false }}
+        run: git push origin ${{ steps.version.outputs.tag }}
+
+      - name: Create GitHub Release
+        if: ${{ inputs.dry_run == false }}
+        run: |
+          PRERELEASE_FLAG=""
+          if [[ "${{ steps.version.outputs.prerelease }}" == "true" ]]; then
+            PRERELEASE_FLAG="--prerelease"
+          fi
+
+          gh release create "${{ steps.version.outputs.tag }}" \
+            --generate-notes \
+            $PRERELEASE_FLAG
+        env:
+          GH_TOKEN: ${{ github.token }}

package/.oxfmtignore

@@ -0,0 +1,2 @@
+dist
+pnpm-lock.yaml

package/.oxfmtrc.jsonc

@@ -0,0 +1,12 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+}

package/.oxlintrc.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["typescript"],
+  "categories": {
+    "correctness": "error",
+    "suspicious": "warn",
+    "perf": "warn"
+  },
+  "rules": {
+    "typescript/no-floating-promises": "error",
+    "typescript/no-misused-promises": "error",
+    "typescript/await-thenable": "error",
+    "typescript/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
+    "typescript/no-unsafe-type-assertion": "off",
+    "no-await-in-loop": "off"
+  },
+  "ignorePatterns": ["*.d.ts", "*.d.mts"]
+}

package/README.md

@@ -1,70 +1,39 @@
-# Get-Or-Throw / Got
+# Get-Or-Throw
 
 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)
-setting, which is recommended for strict type checking.
+the resulting value is `undefined`.
 
 ## Features
 
-- Typescript assertions for type narrowing.
-- Works with both objects and arrays.
-- Supports negative indexing for arrays.
-- Allows for custom error messages.
-- Zero dependencies.
+- TypeScript assertions for type narrowing
+- Works with both objects and arrays
+- Supports negative indexing for arrays
+- Allows for custom error messages
+- Zero dependencies
 - Provides `got` as alias for `getOrThrow`
 
-## Installation
+## Quick Start
 
 ```bash
 pnpm add get-or-throw
 ```
 
-...or use the equivalent for your package manager.
-
-## 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];
-const value = got(arr, 1); // Output: 2
+import { got } from "get-or-throw";
 
-/** Support for negative indexing */
 const arr = [1, 2, 3];
-const value = got(arr, -1); // Output: 3
-
-/** This will throw an error: "Index 3 is out of bounds." */
-const value = got(arr, 3);
+got(arr, 1); // 2
 
 const obj = { a: 1, b: 2, c: 3 };
-const value = got(obj, "b"); // Output: 2
-
-/** This will throw an error: "Key "d" does not exist in the object." */
-const value = got(obj, "d");
-
-/** This will throw an error: "Failed to find d" */
-const key = "d";
-const value = got(obj, key, `Failed to find ${key}`);
+got(obj, "b"); // 2
+```
 
-/** Null is a valid value */
-const arr = [1, null, 3];
-const value = got(arr, 1); // Output: null
+## Documentation
 
-/** This will throw an error: "Value at index 1 is undefined." */
-const arr = [1, undefined, 3];
-const value = got(arr, 1);
+For full documentation visit
+[get-or-throw.codecompose.dev](https://get-or-throw.codecompose.dev/).
 
-/** Null is a valid value */
-const obj = { a: 1, b: null, c: 3 };
-const value = got(obj, "b"); // Output: null
+## License
 
-/** This will throw an error: "Value at key 'b' is undefined." */
-const obj = { a: 1, b: undefined, c: 3 };
-const value = got(obj, "b");
-```
+MIT

package/dist/{index.d.ts → index-CLvtl5bd.d.ts}

@@ -1,3 +1,4 @@
+//#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.
@@ -11,5 +12,8 @@
  */
 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.d.cts → index-CRoiksIS.d.cts}

@@ -1,3 +1,4 @@
+//#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.
@@ -11,5 +12,8 @@
  */
 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,69 +1,24 @@
-"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,
-  got: () => getOrThrow
-});
-module.exports = __toCommonJS(src_exports);
-
-// src/get-or-throw.ts
+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;
-    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.`
-      );
-    }
-  }
+	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.`);
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getOrThrow,
-  got
-});
+//#endregion
+exports.getOrThrow = getOrThrow;
+exports.got = getOrThrow;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"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,41 +1,22 @@
-// src/get-or-throw.ts
+//#region src/get-or-throw.ts
 function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
-  if (Array.isArray(objOrArr)) {
-    const length = objOrArr.length;
-    let index = keyOrIndex;
-    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.`
-      );
-    }
-  }
+	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.`);
 }
-export {
-  getOrThrow,
-  getOrThrow as got
-};
+//#endregion
+export { getOrThrow, getOrThrow as got };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"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"}