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

geonames-entity-lookup

v2.1.0

Published

Find places in geonames.

Downloads

11

Readme

geonames-entity-lookup

Picture

Travis Codecov version downloads GPL-3.0 semantic-release Commitizen friendly experimental

  1. Overview
  2. Installation
  3. Use
  4. API
  5. Development

Overview

Finds places in geonames. Meant to be used with cwrc-public-entity-dialogs where it runs in the browser.

Although it will not work in node.js as-is, it does use the Fetch API for http requests, and so could likely therefore use a browser/node.js compatible fetch implementation like: isomorphic-fetch.

For queries, we use the geonames search service: https://secure.geonames.org/searchJSON?q=${encodeURIComponent(queryString)}&maxRows=10

To show full page preview of individual places we in effect call: https://geonames.org/[placeId].

Installation

npm i geonames-entity-lookup

Use

import geonamesLookup from 'geonames-entity-lookup';

username

GeoNames is a free service but it requires a user account. This should be provided through CWRC-GitWriter configuration (see more here: https://github.com/cwrc/CWRC-GitWriter).

If you want to use it as a standalone, you can provide the user name adding the following line to index.js: credentials.username = '${YOUR_USERNAME}'

You can create a free user account here account: https://www.geonames.org/login

API

findPlace(query)

where the 'query' argument is an object:

{
    entity:  "The name of the place the user wants to find.",
    options: "TBD"
}

findPlace returns a promise that resolve to an object like the following:

{
   "description": "Paris is the capital and largest city of France. It is situated on the river Seine, in northern France, at the heart of the Île-de-Franc…",
   "id": "https://geonames.org/4345345",
   "name": "Paris",
   "nameType": "place",
   "originalQueryString": "paris",
   "repository": "geonames",
   "uri": "https://geonames.org/4345345",
   "uriForDisplay": "",
   "externalURI": "https://geonames.org/4345345"
}

There is another method mainly made available to facilitate testing (to make it easier to mock calls to the geonames service):

getPlaceLookupURI(query)

where the 'query' argument is the place name to find and the methods return the geonames URL that in turn returns results for the query.

Development

CWRC-Writer-Dev-Docs describes general development practices for CWRC-Writer GitHub repositories, including this one.

Mocking

We use fetch-mock to mock http calls (which we make using the Fetch API rather than XMLHttpRequest).

Continuous Integration

We use Travis.

Release

We follow SemVer, which Semantic Release makes easy. Semantic Release also writes our commit messages, sets the version number, publishes to NPM, and finally generates a changelog and a release (including a git tag) on GitHub.