get-or-throw 1.4.0 → 1.5.0

package/README.md

@@ -1,11 +1,13 @@
 # get-or-throw
 
-A convenience function for adhering to Typescript's `noUncheckedIndexedAccess`
-setting.
+A simple convenience function for safely accessing values in objects and arrays.
+It gets a value from an object or array at a specified key or index, and throw
+an error if the resulting value is `undefined` or `null`. Optionally, you can
+set custom error message.
 
-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.
+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.
 
 ## Features
 
@@ -14,6 +16,7 @@ or null.
 - Supports negative indexing for arrays.
 - Allows for custom error messages.
 - Zero dependencies.
+- Provides `got` as alias for `getOrThrow`
 
 ## Installation
 
@@ -58,3 +61,5 @@ console.log(getOrThrow(arr, 1));
 const obj = { a: 1, b: undefined, c: 3 };
 console.log(getOrThrow(obj, "b"));
 ```
+
+## Alias

package/dist/index.cjs

@@ -20,7 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  getOrThrow: () => getOrThrow
+  getOrThrow: () => getOrThrow,
+  got: () => getOrThrow
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -73,5 +74,6 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getOrThrow
+  getOrThrow,
+  got
 });

package/dist/index.d.cts

@@ -13,4 +13,4 @@
 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 };
+export { getOrThrow, getOrThrow as got };

package/dist/index.d.ts

@@ -13,4 +13,4 @@
 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 };
+export { getOrThrow, getOrThrow as got };

package/dist/index.js

@@ -46,5 +46,6 @@ function getOrThrow(objOrArr, keyOrIndex, errorMessage) {
   }
 }
 export {
-  getOrThrow
+  getOrThrow,
+  getOrThrow as got
 };

package/package.json

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

package/src/get-or-throw.ts

@@ -76,3 +76,6 @@ export function getOrThrow<T extends object, K extends keyof T>(
     }
   }
 }
+
+/** Export the same function under the alias 'got' */
+export { getOrThrow as got };