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

geoip2ws

v3.0.0

Published

Maxmind GeoIP2 Web Services (unofficial) - IP and hostname geolocation

Downloads

1,337,422

Readme

geoip2ws

Unofficial Node.js module for the Maxmind GeoIP2 Web Services.

npm Build Status Coverage Status

Usage

The configuration parameters must be wrapped in an object. This allows the use of spread { ...config, ip: '1.2.3.4' } if you want to keep the main config in a variable. The lookup always returns a Promise.

const geo = require( 'geoip2ws' );

geo( {
  userId:     '12345',
  licenseKey: 'abc678',
  service:    'city',
  ip:         '1.2.3.4',
} )
  .then( console.log )
  .catch( console.error )
;

Installation

You need a Maxmind account ID and license key with enough credits for one of their GeoIP web services. You can find both here.

npm i geoip2ws

Configuration

parameter | type | default | description :----------|:-------|:--------------------------|:----------- userId | string | | User ID licenseKey | string | | License key [ip] | string | me | The IP address or 'me' for your current IP [service] | string | city | insights, country or city [endpoint] | string | https://geoip.maxmind.com | Override endpoint url, include the protocol prefix [timeout] | number | 5000 | Request timeout in ms

{
  ip:         '2a02:abc:def::123',
  userId:     '1234',
  licenseKey: 'abc',
  service:    'country',
  timeout:    2000,
}

Endpoint

You can change the endpoint to use a http proxy or target a specific datacenter. Make sure to prefix the hostname with the protocol, i.e. https://.

For the GeoLite2 web service set the endpoint to https://geolite.info.

Errors

Errors from the request or API are thrown and can be caught in the Promise.

For API errors the message is prefixed with API: string.

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org/

Author

Franklin | Buy me a coffee