パッケージの詳細

nestjs-real-ip

p0vidl098.5kMIT3.0.1

A concise decorator for retrieving an IP address from http request with Nest.js controller method

nestjs, decorator, request ip, ip

readme

Nest.js real ip decorator

A concise decorator for retrieving an IP address from http request with Nest.js controller method.

NPM package link

Installation

```shell script

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


## Example controller

```typescript
import { RealIP } from 'nestjs-real-ip';

@Controller('/')
class TestController {
  @Get('my-ip')
  get(@RealIP() ip: string): string {
    return ip;
  }
}

Under the hood

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.

License

The code is under MIT license. See the LICENSE file for details.

Development

```shell script

Update code, commit and push with git

npm version [ major | minor | patch ] npm publish ```