feat(core): add method to get server address

Author: jmcdo29

packages/common/interfaces/nest-application.interface.ts

@@ -43,6 +43,13 @@ export interface INestApplication extends INestApplicationContext {
     callback?: () => void,
   ): Promise<any>;
 
+  /**
+   * Returns the url the application is listening at, based on OS and IP version. Returns as an IP value either in IPv6 or IPv4
+   *
+   * @returns The IP where the server is listening
+   */
+  url(): string;
+
   /**
    * Starts the application (can be awaited).
    *

packages/core/nest-application.ts

@@ -25,6 +25,7 @@ import { MiddlewareModule } from './middleware/middleware-module';
 import { NestApplicationContext } from './nest-application-context';
 import { Resolver } from './router/interfaces/resolver.interface';
 import { RoutesResolver } from './router/routes-resolver';
+import { platform } from 'os';
 
 const { SocketModule } = optionalRequire(
   '@nestjs/websockets/socket-module',
@@ -237,6 +238,40 @@ export class NestApplication extends NestApplicationContext
     });
   }
 
+  public url(): string {
+    const address = this.getHttpServer().address();
+    if (typeof address === 'string') {
+      if (platform() === 'win32') {
+        return address;
+      }
+      const basePath = encodeURIComponent(address);
+      return `${this.getProtocol()}+unix://${basePath}`;
+    }
+    let host = this.host();
+    if (address && address.family === 'IPv6') {
+      if (host === '::') {
+        host = '::1';
+      } else if (host === '0.0.0.0') {
+        host = '127.0.0.1';
+      }
+    } else {
+      host = '127.0.0.1';
+    }
+    return `${this.getProtocol()}://${host}`;
+  }
+
+  private host(): string | undefined {
+    const address = this.getHttpServer().address();
+    if (typeof address === 'string') {
+      return undefined;
+    }
+    return address && address.address;
+  }
+
+  private getProtocol(): 'http' | 'https' {
+    return this.appOptions && this.appOptions.httpsOptions ? 'https' : 'http';
+  }
+
   public setGlobalPrefix(prefix: string): this {
     this.config.setGlobalPrefix(prefix);
     return this;