A concise decorator for retrieving an IP address from http request with Nest.js controller method.
# Install the upstream version for projects based on NestJS v8 and above
npm install nestjs-real-ip
# Or use the version 1.0.3 for projects based on NestJS v7
npm install nestjs-real-ip@1.0.3
import { RealIP } from 'nestjs-real-ip';
@Controller('/')
class TestController {
@Get('my-ip')
get(@RealIP() ip: string): string {
return ip;
}
}
Based on the tiny module @supercharge/request-ip. It supports a wide list of request headers and properties to get working in almost any environment. See the request-ip module description for details.
Also, see the decorator's tests.
The code is under MIT license. See the LICENSE file for details.
# Update code, commit and push with git
npm version [ major | minor | patch ]
npm publish