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

location-data-kit

v2.0.7

Published

A Node.js package providing functions to access and search location data including countries, states, and cities.

Downloads

17

Readme

Location Data Kit

This is a Node.js package that provides functions to access and search location data including countries, states, and cities.

Features

  • Loads location data from pre-defined JSON files.
  • Provides functions to:
    • Fetch all countries.
    • Search for countries by name (case-insensitive).
    • Fetch all states.
    • Search for states by name (case-insensitive).
    • Fetch all cities.
    • Search for cities by name (case-insensitive).
    • Fetch states belonging to a specific country.
    • Search for states belonging to a specific country (case-insensitive).
    • Fetch cities belonging to a specific state.
    • Search for cities belonging to a specific state (case-insensitive).

Installation

npm install location-data-kit

Usage

const LocationDataKit = require('location-data-kit');

// Fetch all countries
const allCountries = LocationDataKit.fetchAllCountries();
console.log('All Countries:', allCountries);

// Search for countries by name (case-insensitive)
const searchTerm = "France";
const countriesWithName = LocationDataKit.fetchAllCountries(searchTerm);
console.log('Countries with name:', countriesWithName);

// Fetch all states in a specific country
const countryCode = "US";  // Change this to your desired country code
const statesInUS = LocationDataKit.fetchStatesByCountry(countryCode);
console.log('States in US:', statesInUS);

// Search for states in a specific country by name (case-insensitive)
const stateSearchTerm = "California";
const statesInUSWithName = LocationDataKit.fetchStatesByCountry(countryCode, stateSearchTerm);
console.log('States in US with name:', statesInUSWithName);

// Fetch all cities in a specific state
const stateCode = "CA"; // Change this to your desired state code
const citiesInCA = LocationDataKit.fetchCitiesByState(stateCode);
console.log('Cities in CA:', citiesInCA);

// Search for cities in a specific state by name (case-insensitive)
const citySearchTerm = "Los Angeles";
const citiesInCAWithName = LocationDataKit.fetchCitiesByState(stateCode, citySearchTerm);
console.log('Cities in CA with name:', citiesInCAWithName);

Data Files

This package expects three JSON files to be present in the data folder within the package directory:

  • countries.json: An array of objects representing countries, each object should have properties like name and optionally code.
  • states.json: An array of objects representing states, each object should have properties like name, countryCode (referencing a country from countries.json).
  • cities.json: An array of objects representing cities, each object should have properties like name, stateCode (referencing a state from states.json).

Please note: You need to provide your own data for these files or use existing datasets formatted as mentioned above.

License

This package is licensed under the MIT License. See the LICENSE file for details.