get-or-throw 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -9,6 +9,7 @@ setting.
9
9
  - Works with both objects and arrays.
10
10
  - Supports negative indexing for arrays.
11
11
  - Allows for custom error messages.
12
+ - Zero dependencies.
12
13
 
13
14
  ## Installation
14
15
 
package/dist/index.d.cts CHANGED
@@ -8,6 +8,7 @@
8
8
  * @returns The value at the given key or index.
9
9
  * @throws An error if the key or index does not exist.
10
10
  */
11
- declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T | T[], keyOrIndex: K | number, errorMessage?: string): T[K] | T;
11
+ declare function getOrThrow<T extends object, K extends keyof T>(obj: T, key: K, errorMessage?: string): T[K];
12
+ declare function getOrThrow<T>(arr: T[], index: number, errorMessage?: string): T;
12
13
 
13
14
  export { getOrThrow };
package/dist/index.d.ts CHANGED
@@ -8,6 +8,7 @@
8
8
  * @returns The value at the given key or index.
9
9
  * @throws An error if the key or index does not exist.
10
10
  */
11
- declare function getOrThrow<T extends object, K extends keyof T>(objOrArr: T | T[], keyOrIndex: K | number, errorMessage?: string): T[K] | T;
11
+ declare function getOrThrow<T extends object, K extends keyof T>(obj: T, key: K, errorMessage?: string): T[K];
12
+ declare function getOrThrow<T>(arr: T[], index: number, errorMessage?: string): T;
12
13
 
13
14
  export { getOrThrow };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "get-or-throw",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "description": "A convenience function for adhering to Typescript's noUncheckedIndexedAccess rule",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
@@ -8,6 +8,16 @@
8
8
  * @returns The value at the given key or index.
9
9
  * @throws An error if the key or index does not exist.
10
10
  */
11
+ export function getOrThrow<T extends object, K extends keyof T>(
12
+ obj: T,
13
+ key: K,
14
+ errorMessage?: string
15
+ ): T[K];
16
+ export function getOrThrow<T>(
17
+ arr: T[],
18
+ index: number,
19
+ errorMessage?: string
20
+ ): T;
11
21
  export function getOrThrow<T extends object, K extends keyof T>(
12
22
  objOrArr: T | T[],
13
23
  keyOrIndex: K | number,