Merge pull request nestjs#3249 from iniel/add-ip-route-param

feat(): add ip route param decorator

Author: kamilmysliwiec

packages/common/decorators/http/route-params.decorator.ts

@@ -106,6 +106,19 @@ export const Next: () => ParameterDecorator = createRouteParamDecorator(
   RouteParamtypes.NEXT,
 );
 
+/**
+ * Route handler parameter decorator. Extracts the `Ip` property
+ * from the `req` object and populates the decorated
+ * parameter with the value of `ip`.
+ *
+ * @see [Request object](https://docs.nestjs.com/controllers#request-object)
+ *
+ * @publicApi
+ */
+export const Ip: () => ParameterDecorator = createRouteParamDecorator(
+  RouteParamtypes.IP,
+);
+
 /**
  * Route handler parameter decorator. Extracts the `Session` object
  * from the underlying platform and populates the decorated

packages/common/enums/route-paramtypes.enum.ts

@@ -9,4 +9,5 @@ export enum RouteParamtypes {
   SESSION,
   FILE,
   FILES,
+  IP,
 }

packages/core/router/route-params-factory.ts

@@ -32,6 +32,8 @@ export class RouteParamsFactory implements IRouteParamsFactory {
         return req[data || 'file'];
       case RouteParamtypes.FILES:
         return req.files;
+      case RouteParamtypes.IP:
+        return req.ip;
       default:
         return null;
     }

packages/core/test/router/route-params-factory.spec.ts

@@ -11,6 +11,7 @@ describe('RouteParamsFactory', () => {
     const res = {};
     const next = () => ({});
     const req = {
+      ip: 'ip',
       session: null,
       body: {
         foo: 'bar',
@@ -73,6 +74,13 @@ describe('RouteParamsFactory', () => {
           ).to.be.eql(req.headers);
         });
       });
+      describe(`RouteParamtypes.IP`, () => {
+        it('should return ip property', () => {
+          expect(
+            (factory as any).exchangeKeyForValue(RouteParamtypes.IP, ...args),
+          ).to.be.equal(req.ip);
+        });
+      });
       describe(`RouteParamtypes.SESSION`, () => {
         it('should return session object', () => {
           expect(