Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Repository files navigation

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!

Build Statuscodecov

Usage

Installation

npm install @mapbox/vtinfo

Get information as JSON

varfs=require('fs');varvtinfo=require('@mapbox/vtinfo');// get a vector tile buffervarbuffer=fs.readFileSync('/path/to/tile.vector.pbf');// get info about the buffervarinfo=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.

About

DEPRECATED Get general information and stats about a particular vector tile buffer.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

7 stars

Watchers

35 watching

Forks

Releases

Packages

Used by

Contributors

Languages