npmpackage.info

Gathering detailed insights and metrics for worldcities

worldcities

A convenient wrapper for the GeoNames database of world cities data.

0.1.8

Unlicense

TypeScript

467.49 kB

44,111 3

Installations

npm install worldcities

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.19.0

NPM Version

9.5.1 Pull Requests

Open

13

Total

24

Closed

2

Merged

9

Issues

Open

1

Total

5

Closed

4

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 3 contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (51.27%)

JavaScript (45.02%)

Shell (3.72%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

OpenDataFormats

Download Statistics

Total Downloads

44,111

Last Day

Last Week

Last Month

344

Last Year

7,739

GitHub Statistics

10 Stars

59 Commits

5 Forks

2 Watching

14 Branches

3 Contributors

Bundle Size

1.38 MB

Minified

467.49 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

0.1.8

Package Id

worldcities@0.1.8

Unpacked Size

7.29 MB

Size

2.07 MB

File Count

528

NPM Version

9.5.1

Node Version

14.19.0

Publised On

15 Mar 2023

Total Downloads

Cumulative downloads

Total Downloads

44,111

Last day

-77.5%

Compared to previous day

Last week

-43.2%

Compared to previous week

Last month

2.4%

344

Compared to previous month

Last year

-33.7%

7,739

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

World Cities

24,343 world cities and 252 countries.

A convenient wrapper for the GeoNames database of world cities data.

The data from the GeoNames tab seperated values files are parsed and normalized into a JSON object for quick lookup and distance calculations. The data for each city's country is also normalized, indexed by ISO_3166-1 country code, paired with the country's flag's SVG, GeoJSON of its boundaries, and relative URL to Wikipedia page.

Usage

Query for a city by GPS

1const WorldCities = require('worldcities');
2const city = WorldCities.getNearestCity(5.42282298420212, 100.33753796627954);
3
4// City {
5//   latitude: 5.41123,
6//   longitude: 100.33543,
7//   name: 'George Town',
8//   population: 300000,
9//   timezone: 'Asia/Kuala_Lumpur',
10//   country: Country {
11//     areaSquareMeters: 329750,
12//     callingCode: '60',
13//     capital: 'Kuala Lumpur',
14//     continent: 'AS',
15//     countryCode: 'MY',
16//     countryCode3: 'MYS',
17//     currencyCode: 'MYR',
18//     currencyName: 'Ringgit',
19//     languages: [
20//       'ms-MY', 'en',
21//       'zh',    'ta',
22//       'te',    'ml',
23//       'pa',    'th'
24//     ],
25//     name: 'Malaysia',
26//     neighbors: [ 'BN', 'TH', 'ID' ],
27//     population: 31528585,
28//     postalCodeRegExp: '^(\\d{5})$',
29//     tld: '.my',
30//     wikipedia: 'Malaysia',
31//     geoJSON: undefined,
32//     flagSVG: undefined
33//   }
34// }

Query for a large city by GPS

1const WorldCities = require('worldcities');
2const city = WorldCities.getNearestLargeCity(17.076480407330514, -101.3674415353851);

Query for a single city by name

1const city = WorldCities.getByName('Tokyo');

Query all cities matching a name

1const cities = WorldCities.getByName('nEw yOrK');
2assert.equal(cities.length, 3);

Get a Country by Country Code

Retrieve the country data by querying for it by the 2 letter country code. The second argument returns the Country with full data, including geoJSON and flag SVG.

1const country = WorldCities.getCountry('NZ', true);
2fs.writeFileSync('nz.flag.svg', country.flagSVG);

Timezones

The city data includes the IANA timezone ID in string format; ie. "America/Los_Angeles". To use these to localize dates and times to the city, it's highly recommended to use the Moment Timezone library.

For example, to convert a UNIX timestamp to a localized date time string:

1const moment = require('moment-timezone');
2
3moment(Math.floor(Date.now() / 1000), 'X')
4  .tz('America/Los_Angeles')
5  .format('dddd, MMMM Do YYYY, h:mm:ss a z');
6
7// "Friday, May 1st 2020, 5:52:11 am PDT"

GeoJSON

GeoJSON objects can be visualized nicely in the http://geojson.io/ UI.

Google Maps also supports using GeoJSON as a "Data Layer" via the API.

SQLite

All of the data is also available in a compact SQLite file. It is in the source repository, but not included in the package to keep size reasonable.

[https://raw.githubusercontent.com/OpenDataFormats/worldcities/master/data/worldcities.sqlite]

Data Sources

City and country data:

GeoNames

Flag SVG data

flag-icon-css

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More