# vtinfo

**Repository Path**: mirrors_mapbox/vtinfo

## Basic Information

- **Project Name**: vtinfo
- **Description**: DEPRECATED Get general information and stats about a particular vector tile buffer.
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vtinfo

:warning: **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](http://github.com/mapbox/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()`](http://mapnik.org/documentation/node-mapnik/3.5/#VectorTile.info). Useful for testing!

[![Build Status](https://travis-ci.com/mapbox/vtinfo.svg?branch=master)](https://travis-ci.com/mapbox/vtinfo)
[![codecov](https://codecov.io/gh/mapbox/vtinfo/branch/master/graph/badge.svg)](https://codecov.io/gh/mapbox/vtinfo)

# Usage

Installation

```
npm install @mapbox/vtinfo
```

Get information as JSON

```javascript
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`)

```bash
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`.