cleanup: removes deprecated use of currentEnvironment

Author: joelgallant

app-config-node/src/environment.test.ts

@@ -7,25 +7,6 @@ import {
 } from './environment';
 
 describe('currentEnvironment', () => {
-  describe('deprecated currentEnvironment', () => {
-    it('uses environmentSourceNames', () => {
-      process.env.NODE_ENV = 'foo';
-      process.env.FOO = 'bar';
-
-      expect(currentEnvironment(undefined, ['FOO', 'BAR'])).toBe('bar');
-      expect(currentEnvironment(undefined, ['BAR'])).toBe(undefined);
-    });
-
-    it('uses environmentAliases', () => {
-      process.env.FOO = 'bar';
-      process.env.NODE_ENV = 'bar';
-
-      expect(currentEnvironment({}, ['FOO'])).toBe('bar');
-      expect(currentEnvironment({ bar: 'foo' })).toBe('foo');
-      expect(currentEnvironment({ bar: 'foo' }, ['FOO'])).toBe('foo');
-    });
-  });
-
   it('uses envVarNames', () => {
     process.env.NODE_ENV = 'foo';
     process.env.FOO = 'bar';
@@ -49,8 +30,14 @@ describe('currentEnvironment', () => {
 
   it('uses override', () => {
     process.env.NODE_ENV = 'foo';
-    expect(currentEnvironment({})).toBe('foo');
-    expect(currentEnvironment({ override: 'bar' })).toBe('bar');
+    expect(currentEnvironment()).toBe('foo');
+    expect(
+      currentEnvironment({
+        override: 'bar',
+        aliases: defaultAliases,
+        envVarNames: defaultEnvVarNames,
+      }),
+    ).toBe('bar');
   });
 });
 

app-config-node/src/environment.ts

@@ -48,50 +48,21 @@ export function asEnvOptions(
 }
 
 /** Retrieve what app-config thinks the current deployment environment is (ie QA, dev, staging, production) */
-export function currentEnvironment(options?: EnvironmentOptions): string | undefined;
-
-/** @deprecated use currentEnvironment(EnvironmentOptions) instead */
-export function currentEnvironment(
-  environmentAliases?: EnvironmentAliases,
-  environmentSourceNames?: string[] | string,
-): string | undefined;
-
-export function currentEnvironment(...args: any[]): string | undefined {
+export function currentEnvironment(options?: EnvironmentOptions): string | undefined {
   let environmentSourceNames: string[] = defaultEnvVarNames;
   let environmentAliases: EnvironmentAliases = defaultAliases;
   let environmentOverride: string | undefined;
 
-  if (
-    args[0] &&
-    typeof args[0] === 'object' &&
-    ('override' in args[0] || 'aliases' in args[0] || 'envVarNames' in args[0])
-  ) {
-    const options = args[0] as EnvironmentOptions;
-
-    if (options.override) {
-      environmentOverride = options.override;
-    }
-
-    if (options.aliases) {
-      environmentAliases = options.aliases;
-    }
+  if (options?.override) {
+    environmentOverride = options.override;
+  }
 
-    if (options.envVarNames) {
-      environmentSourceNames = options.envVarNames;
-    }
-  } else {
-    if (args[0]) {
-      environmentAliases = args[0] as EnvironmentAliases;
-      logger.warn('Detected deprecated usage of currentEnvironment');
-    }
+  if (options?.aliases) {
+    environmentAliases = options.aliases;
+  }
 
-    if (Array.isArray(args[1])) {
-      environmentSourceNames = args[1] as string[];
-      logger.warn('Detected deprecated usage of currentEnvironment');
-    } else if (typeof args[1] === 'string') {
-      environmentSourceNames = [args[1]];
-      logger.warn('Detected deprecated usage of currentEnvironment');
-    }
+  if (options?.envVarNames) {
+    environmentSourceNames = options.envVarNames;
   }
 
   if (environmentOverride) {