geojson-validation

GeoJSON-Validation

A GeoJSON Validation Library
Check JSON objects to see whether or not they are valid GeoJSON. Validation is based off of the GeoJSON Format Specification revision 1.0

Installation

npm install geojson-validation

Functions

All Function return a boolean and take a JSON object that will be evalatued to see if it is a GeoJSON object.

Arguments

• geoJSON - a JSON object that is tested to see if it is a valid GeoJSON object
• callback(boolean, errors) - errors is an array of validation errors for an invalid JSON object

valid(geoJON, callback)

Alias: isGeoJSONObject
Checks if an object is a GeoJSON Object.

isGeoJSONObject(geoJSON, callback)

Checks if an object is a GeoJSON Object.

isPosition(array, callback)

Checks if an array is a Position

isGeometryObject(geoJSON, callback)

Checks if an object is a Geometry Object

isPoint(geoJSON, callback)

Checks if an object is a Point

isMultiPoint(geoJSON, callback)

Checks if an object is a MultiPoint

isLineString(geoJSON, callback)

Checks if an object is a Line String

isMultiLineString(geoJSON, callback)

Checks if an object is a MultiLine String

isPolygon(geoJSON, callback)

Checks if an object is a Polygon

isMultiPolygon(geoJSON, callback)

Checks if an object is a MultiPolygon

isGeometryCollection(geoJSON, callback)

Checks if an object is a Geometry Collection

isFeature(geoJSON, callback)

Checks if an object is a Feature Object

isFeatureCollection(geoJSON, callback)

Checks if an object is a Feature Collection Object

isBbox(geoJSON, callback)

Checks if an object is a Bounding Box

Example

gjVal = require("geojson-validation");

var validFeatureCollection = {
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "geometry": {"type": "Point", "coordinates": [102.0, 0.5]},
            "properties": {"prop0": "value0"}
        },
        {
            "type": "Feature",
            "geometry": {
                "type": "LineString",
                "coordinates": [
                    [102.0, 0.0], [103.0, 1.0], [104.0, 0.0], [105.0, 1.0]
                ]
            },
            "properties": {
                "prop0": "value0",
                "prop1": 0.0
            }
        }
    ]
};

//simple test
if(gjVal.valid(validFeatureCollection)){
    console.log("this is valid GeoJSON!");
}

var invalidFeature =  {
    "type": "feature",
    "geometry": {
        "type": "LineString",
        "coordinates": [
            [102.0, 0.0], [103.0, 1.0], [104.0, 0.0], [105.0, 1.0]
        ]
    },
    "properties": {
        "prop0": "value0",
        "prop1": 0.0
    }
};

//test to see if `invalidFeature` is valid
gjVal.isFeature(invalidFeature, function(valid, errs){
    //log the errors
    if(!valid){
    console.log(errs);
    }
});

Testing

To run tests npm test
Test use mocha

Cavets

• Does not check ordering ob Bouding Box coordinates
• Does not check Coordinate Reference System Objects
• Does not check order of rings for polygons with multiple rings