Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

geojson-stream

tmcw49.2kBSD-2-Clause0.1.0

stream features into and out of geojson

geojson, stream, maps, json, pipe

readme

geojson-stream

Greenkeeper badge build status

Stream features into and out of GeoJSON objects and Feature Collections. Little more than JSONStream with pre-filled settings.

usage

npm install --save geojson-stream

api

geojsonStream.stringify()

Returns a transform stream that accepts GeoJSON Feature objects and emits a stringified FeatureCollection.

geojsonStream.parse(mapFunc)

Returns a transform stream that accepts a GeoJSON FeatureCollection as a stream and emits Feature objects.

mapFunc(feature, index) is an optional function which takes a Feature, and its zero-based index in the FeatureCollection and returns either a Feature, or null/undefined if the feature should be omitted from output.

example

const geojsonStream = require('geojson-stream');
const fs = require('fs');
const out = fs.createWriteStream('buildings-with-id.geojson');
fs
    .createReadStream(`buildings.geojson`)
    .pipe(geojsonStream.parse((building, index) => {
        if (building.geometry.coordinates === null) {
            return null;
        }
        building.id = index;
        return building;
    }))
    .pipe(geojsonStream.stringify())
    .pipe(out);

changelog

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.1.0 (2019-01-16)

Features

  • Support passing a mapping function, plus add example to readme. (#7) (5f8c647)