fix: remove getIntegerThrowInvalid

Author: stopsopa

README.md

@@ -86,7 +86,6 @@ import {
   getValidatedThrow,
   getDefaultIfInvalid,
 
-  getIntegerThrowInvalid, // equivalent to get
   getIntegerDefault,
   getIntegerThrow,  
 } from "envprocessor";
@@ -235,7 +234,6 @@ import {
   getValidatedThrow,
   getDefaultIfInvalid,
 
-  getIntegerThrowInvalid, // equivalent to get
   getIntegerDefault,
   getIntegerThrow, 
 } from "envprocessor";
@@ -251,7 +249,6 @@ const {
   getValidatedThrow,
   getDefaultIfInvalid,
 
-  getIntegerThrowInvalid, // equivalent to get
   getIntegerDefault,
   getIntegerThrow,  
 } = require("envprocessor");
@@ -268,7 +265,6 @@ console.log(`get('USER') >${get("USER")}`);
 - `getTrimmedThrow(key)`: Retrieves, trims, and throws an error if the variable is missing or empty after trimming.
 - `getValidatedThrow(key, validator)`: Retrieves and validates using a `RegExp` or a custom function. The validator function should return an error message `string` on failure, or `null`/`undefined` on success. It can also throw an error directly.
 - `getDefaultIfInvalid(key, defaultValue, validator)`: Retrieves and validates using a `RegExp` or a custom function. If validation fails (regex mismatch, function returns anything other than `null`/`undefined`, or function throws) or the variable is not found, it returns the specified `defaultValue`.
-- `getIntegerThrowInvalid(key)`: Retrieves and converts to an integer. Throws if it exists but is not a valid integer.
 - `getIntegerDefault(key, defaultValue)`: Retrieves as an integer, or returns `defaultValue` if not found or invalid.
 - `getIntegerThrow(key)`: Retrieves as an integer, throws if missing or invalid.
 

examples/index.html

@@ -34,7 +34,6 @@
         get,
         getDefault,
         getThrow,
-        getIntegerThrowInvalid,
         getIntegerDefault,
         getIntegerThrow,
       } from "env";

src/source/env.ts

@@ -173,36 +173,6 @@ export function getDefaultIfInvalid(
 
 const intTest = /^-?\d+$/;
 
-/**
- * Retrieves an environment variable and converts it to an integer.
- *
- * @param key - The name of the environment variable.
- * @returns The integer value if it exists and is valid, otherwise undefined.
- * @throws Will throw an error if the variable exists but cannot be converted to a valid integer.
- */
-export function getIntegerThrowInvalid(key: string): number | undefined {
-  if (has(key)) {
-    // We know the value exists because has(key) returned true
-    const value = get(key) as string;
-
-    if (!intTest.test(value)) {
-      throw th(`env var ${key} is not a number. value >${value}<, doesn't match regex >${intTest}<`);
-    }
-
-    const int = parseInt(value, 10);
-
-    const strint = String(int);
-
-    if (!intTest.test(strint)) {
-      throw th(`parseInt(${value}, 10) returned ${strint}, doesn't match regex >${intTest}<`);
-    }
-
-    return int;
-  }
-
-  return undefined;
-}
-
 /**
  * Retrieves an environment variable as an integer, or returns a default value if not found or invalid.
  *
@@ -212,11 +182,7 @@ export function getIntegerThrowInvalid(key: string): number | undefined {
  */
 export function getIntegerDefault(key: string, defaultValue: number): number {
   try {
-    const val = getIntegerThrowInvalid(key);
-
-    if (typeof val === "number") {
-      return val;
-    }
+    return getIntegerThrow(key);
   } catch (e) {}
 
   return defaultValue;
@@ -230,11 +196,19 @@ export function getIntegerDefault(key: string, defaultValue: number): number {
  * @throws Will throw an error if the variable is not defined or cannot be converted to a valid integer.
  */
 export function getIntegerThrow(key: string): number {
-  const val = getIntegerThrowInvalid(key);
+  const value = getThrow(key);
+
+  if (!intTest.test(value)) {
+    throw th(`env var ${key} is not a number. value >${value}<, doesn't match regex >${intTest}<`);
+  }
+
+  const int = parseInt(value, 10);
+
+  const strint = String(int);
 
-  if (typeof val === "number") {
-    return val;
+  if (!intTest.test(strint)) {
+    throw th(`parseInt(${value}, 10) returned ${strint}, doesn't match regex >${intTest}<`);
   }
 
-  throw th(`env var ${key} is not defined or is not a number`);
+  return int;
 }

tests/env.unit.js

@@ -4,7 +4,6 @@ import {
   mockEnv,
   get,
   getDefault,
-  getIntegerThrowInvalid,
   getIntegerDefault,
   getIntegerThrow,
   getThrow,
@@ -45,23 +44,6 @@ it("getThrow - ABC -> DEF", async () => {
   expect(() => getThrow("GHI")).toThrowError("env.js: env var GHI is not defined");
 });
 
-it("getIntegerThrowInvalid - ABC -> 123", async () => {
-  mockEnv({
-    ABC: "123",
-    ZZZ: "not a number",
-    BIG: "90071992547409919007199254740991",
-  });
-
-  expect(getIntegerThrowInvalid("ABC")).toEqual(123);
-  expect(getIntegerThrowInvalid("GHI")).toEqual(undefined);
-  expect(() => getIntegerThrowInvalid("ZZZ")).toThrowError(
-    "env.js: env var ZZZ is not a number. value >not a number<, doesn't match regex >/^-?\\d+$/<",
-  );
-  expect(() => getIntegerThrowInvalid("BIG")).toThrowError(
-    "env.js: parseInt(90071992547409919007199254740991, 10) returned 9.007199254740992e+31, doesn't match regex >/^-?\\d+$/<",
-  );
-});
-
 it("getIntegerDefault - ABC -> 123", async () => {
   mockEnv({
     ABC: "123",
@@ -96,7 +78,7 @@ test("getIntegerThrow", async () => {
   }
 
   expect(data).toEqual({
-    throw: "env.js: env var GHI is not defined or is not a number",
+    throw: "env.js: env var GHI is not defined",
     throw2: "env.js: env var ZZZ is not a number. value >not a number<, doesn't match regex >/^-?\\d+$/<",
   });
 });