request-country
TypeScript icon, indicating that this package has built-in type declarations

0.1.6 • Public • Published

request-country NPM version

Get 2-letter country code from http request in nodejs.

Installation

npm i request-country

Usage

var http = require('http');
var requestCountry = require('request-country');
var server = http.createServer(function(req, res) {
  console.log(requestCountry(req));
  // If it cannot detect country code from request ip,
  // the function return false.
});

If you want to set default value for private network IPs, you can pass second argument. So if you open your site from private network or localhost it will be returned.

  requestCountry(req, 'US');

You can get country code from ip address string as requestCountry('2.2.2.2').

As Connect Middleware

var requestCountry = require('request-country');
app.use(requestCountry.middleware({
  attributeName: 'requestCountryCode', // default is 'requestCountryCode'
  privateIpCountry: 'US' // Result for private network IPs
}));

app.use(function(req, res) {
  res.end(req.requestCountryCode);
});

LICENSE

This library use the geoip-country for getting country code. geoip-country includes GeoLite2 ipv4 and ipv6 country data which created by MaxMind, available from https://www.maxmind.com. Thus, the license of this library is based on the GeoLite2 License. See the LICENSE file for details.

Readme

Keywords

Package Sidebar

Install

npm i request-country

Weekly Downloads

388

Version

0.1.6

License

none

Unpacked Size

3.78 kB

Total Files

4

Last publish

Collaborators

  • sapics