fix(types): changed NodeJS.ProcessEnv type to Record in node-config-p…

…rovider (#4319) * fix(types): changed NodeJS.ProcessEnv type to Record in node-config-provider package * chore: added comments explaining the changes
aws · Jan 25, 2023 · 872fe07 · 872fe07
1 parent 640f7f6
commit 872fe07
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/packages/node-config-provider/src/configLoader.spec.ts b/packages/node-config-provider/src/configLoader.spec.ts
@@ -25,7 +25,8 @@ describe("loadConfig", () => {
     (fromSharedConfigFiles as jest.Mock).mockReturnValueOnce(mockFromSharedConfigFilesReturn);
     const mockFromStatic = "mockFromStatic";
     (fromStatic as jest.Mock).mockReturnValueOnce(mockFromStatic);
-    const envVarSelector = (env: NodeJS.ProcessEnv) => env["AWS_CONFIG_FOO"];
+    // Using Record<string, string | undefined> instead of NodeJS.ProcessEnv, in order to not get type errors in non node environments
+    const envVarSelector = (env: Record<string, string | undefined>) => env["AWS_CONFIG_FOO"];
     const configKey = (profile: Profile) => profile["aws_config_foo"];
     const defaultValue = "foo-value";
     loadConfig(

diff --git a/packages/node-config-provider/src/fromEnv.spec.ts b/packages/node-config-provider/src/fromEnv.spec.ts
@@ -5,7 +5,9 @@ import { fromEnv, GetterFromEnv } from "./fromEnv";
 describe("fromEnv", () => {
   describe("with env var getter", () => {
     const envVarName = "ENV_VAR_NAME";
-    const envVarGetter: GetterFromEnv<string> = (env: NodeJS.ProcessEnv) => env[envVarName]!;
+
+    // Using Record<string, string | undefined> instead of NodeJS.ProcessEnv, in order to not get type errors in non node environments
+    const envVarGetter: GetterFromEnv<string> = (env: Record<string, string | undefined>) => env[envVarName]!;
     const envVarValue = process.env[envVarName];
     const mockEnvVarValue = "mockEnvVarValue";
 

diff --git a/packages/node-config-provider/src/fromEnv.ts b/packages/node-config-provider/src/fromEnv.ts
@@ -1,7 +1,8 @@
 import { CredentialsProviderError } from "@aws-sdk/property-provider";
 import { Provider } from "@aws-sdk/types";
 
-export type GetterFromEnv<T> = (env: NodeJS.ProcessEnv) => T | undefined;
+// Using Record<string, string | undefined> instead of NodeJS.ProcessEnv, in order to not get type errors in non node environments
+export type GetterFromEnv<T> = (env: Record<string, string | undefined>) => T | undefined;
 
 /**
  * Get config value given the environment variable name or getter from