README.md

vtinfo

⚠️ Not under active development! If you're using this for tests to assert information in a vector tile buffer, we recommend using vector-tile-js.

Get general information and stats about a particular vector tile buffer. Meant as a lightweight replacement to Node Mapnik's mapnik.VectorTile.info(). Useful for testing!

Usage

Installation

npm install @mapbox/vtinfo

Get information as JSON

var fs = require('fs');
var vtinfo = require('@mapbox/vtinfo');

// get a vector tile buffer
var buffer = fs.readFileSync('/path/to/tile.vector.pbf');

// get info about the buffer
var info = vtinfo(buffer);
console.log(info);
// { layers: 
//    [ { name: 'landuse',
//        version: 2,
//        features: 5,
//        unknown_features: 0,
//        point_features: 0,
//        line_features: 0,
//        polygon_features: 5,
//        invalid_features: 0 },
//      { name: 'water',
//        version: 2,
//        features: 3,
//        unknown_features: 0,
//        point_features: 0,
//        line_features: 0,
//        polygon_features: 3,
//        invalid_features: 0 } 
//   ]
// }

Command line (assumes you've installed the module globally with -g)

vtinfo <path to tile>

Develop & Test

Set up your environment by running make, which will install dependencies and build binaries.

Run tests with npm test.