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

@terrestris/geojson-walk

v1.0.4

Published

Validate and clean GeoJSON

Downloads

19

Readme

geojson-walk

A tiny library to apply a function to a GeoJSON. In case of a FeatureCollection, the function will also be applied to the single Features.

This can be used to eg. gather statistics about the GeoJSON (spatial extent, attributes, …) or to change / clean it. Have a look at the examples below to get an idea of what is possible.

Installation

npm i @terrestris/geojson-walk

API

This module exposes one function walk:

walk(o, fn, doExpectChange) ⇒ object

Walk the GeoJSON and apply the provided function to it or its features (in case of a FeatureCollection). If you expect your function to change the passed GeoJSON Feature Collection, then pass the third parameter as true. In that case the return value of the function determines what ends up in the returned GeoJSON. If you return something truthy, the return value will be used, otherwise the Feature will not be in the returned collection.

Kind: global function Returns: object - The (possibly changed) GeoJSON.

| Param | Type | Description | | --- | --- | --- | | o | object | The GeoJSON we will walk. We do not check whether this is actually a fully valid GeoJSON. | | fn | function | The function we will call. Will receive the GeoJSON or each feature of the collection. | | doExpectChange | boolean | Whether you expect your function might change the GeoJSON. |

Example

Simple usage example:

import walk from '@terrestris/geojson-walk';

const filterForProp = (f) => {
  if (f.properties.humpty === 'dumpty') {
    return f;
  } else {
    return null;
  }
};

const featureCollection = {
  type: 'FeatureCollection',
  features: [
    {
      type: 'Feature',
      properties: {
        humpty: 'dumpty'
      },
      geometry: {
        type: 'Point',
        coordinates: [
          0,
          1
        ]
      }
    },
    {
      type: 'Feature',
      properties: {
        humpty: 'trumpty'
      },
      geometry: {
        type: 'Point',
        coordinates: [
          2,
          3
        ]
      }
    }
  ]
};

const cleanCollection = walk(featureCollection, filterForProp, true);

contributions welcome

npm version GitHub

Build Status Coverage Status

dependencies Status devDependencies Status Known Vulnerabilities