npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@loxjs/express-client-ip

v2.1.2

Published

An npm module for obtaining a client's IP address in Express.js applications.

Downloads

14

Readme

@loxjs/express-client-ip

@loxjs/express-client-ip is an npm module for obtaining a client's IP address in Express.js applications. It accounts for requests forwarded by proxy servers, such as Caddy, Nginx, Apache, CloudFlare, etc., and attempts to extract the original client IP address from various HTTP header fields.

Features

  • Retrieves IP addresses from HTTP headers like X-Real-IP, X-Forwarded-For, CF-Connecting-IP, and others.
  • Compatible with both IPv4 and IPv6 addresses.
  • Provides middleware function for easy integration into Express.js applications.
  • Automatically handles scenarios involving multiple proxy servers.
  • Returns the client's IP address for a request or null if undetermined.

Installation

Install using npm:

npm install @loxjs/express-client-ip

Or with yarn:

yarn add @loxjs/express-client-ip

Usage

As Middleware

In your Express.js application, you can use @loxjs/express-client-ip as middleware to set the req.clientIp property on every request.

const express = require('express');
const getClientIP = require('@loxjs/express-client-ip');

const app = express();

// Apply middleware
app.use(getClientIP.middleware);

app.get('/', (req, res) => {
  res.send(`Your IP is: ${req.clientIp}`);
});

app.listen(3000);

As a Function

You can also directly call the getIP function to obtain the client's IP address.

const getClientIP = require('@loxjs/express-client-ip');

app.get('/some-path', (req, res) => {
  const ip = getClientIP(req);
  res.send(`Your IP is: ${ip}`);
});

API Reference

getIP Function

  • getIP(req): Extracts the client IP address from the request object.
    • req: The request object from Express.js.

getIP.middleware Function

  • getIP.middleware: An Express.js middleware that adds the client's IP address to the req.clientIp property.

Contributing

Contributions to @loxjs/express-client-ip are welcome! Please ensure that your contributions adhere to the following guidelines:

  • Write clear, readable, and maintainable code.
  • Follow existing coding styles and practices.
  • Write meaningful commit messages.
  • Update the documentation accordingly.

For more detailed information, please read the contributing guide.

Enjoy using @loxjs/express-client-ip!