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

@koopjs/provider-file-geojson

v2.2.0

Published

Simple provider for serving file-based GeoJSON

Downloads

255

Readme

koop-provider-file-geojson

Serve local GeoJSON files as Koop services. Use as a standalone Koop instance or add to an existing Koop implementation.

Getting Started

Add the provider to your koop instance

sh $ npm install @koopjs/provider-file-geojson

Then register the provider with Koop in your server file.

const Koop = require('koop')
const koop = new Koop()

const provider = require('@koopjs/provider-file-geojson')
koop.register(provider)

Usage

The provider will look for requested geojson files in a /data directory in the koop application root. For example, the following request will serve data from the file data/polygon-sample.geojson :

$ curl http://localhost:8080/file-geojson/rest/services/polygon-sample/FeatureServer/0/query

Usage

Setting the data directory

The provider needs to know where to locate the GeoJSON files it should serve. A directory can be assign in several ways. By default, the provider looks for files in the /data directory in the koop application root. For example, the following request will serve data from the file data/polygon-sample.geojson:

$ curl http://localhost:8080/file-geojson/rest/services/polygon-sample/FeatureServer/0/query

You can override where the provider looks by adding a dataDir field to the provider's registration options:

const Koop = require('koop')
const koop = new Koop()

const provider = require('@koopjs/provider-file-geojson')
koop.register(provider, { dataDir: 'path-to-data-directory'})

You can also achieve the same by setting an environment variable KOOP_DATA_DIR=<path-to-directory>. Paths should be relative to the koop server file.

Files

All valid GeoJSON files can be served. Place them in the data directory and ensure they have a .geojson file extension.

Request parameters

Request a particular file by using the (extension-less) file name as the :id parameter in the URL. For example, when requesting data from the file point-fc.geojson: http://localhost:8080/file-geojson/rest/services/:id/FeatureServer/0/query

becomes:

http://localhost:8080/file-geojson/rest/services/point-fc/FeatureServer/0/query

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

License

Apache 2.0