# store-mvt

> An experiment in makeing a set of mbtiles from the output of geojson-vt

Latest version **1.1.1** (published 2018-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install store-mvt
pnpm add store-mvt
yarn add store-mvt
bun add store-mvt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2018-06-11 |
| First published | 2017-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 231.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Steven Kalt |
| Maintainers | skalt |
| Keywords | geojson, geojson-vt, mvt, vector tiles, pbf, GIS |

## Links

- npm: https://www.npmjs.com/package/store-mvt
- Repository: https://github.com/SKalt/store-mvt
- Homepage: https://github.com/SKalt/store-mvt#readme
- Issues: https://github.com/SKalt/store-mvt/issues
- npm.io page: https://npm.io/package/store-mvt

## Dependencies (6)

- [debug](https://npm.io/package/debug.md) ^3.1.0
- [vt-pbf](https://npm.io/package/vt-pbf.md) ^3.1.0
- [@turf/bbox](https://npm.io/package/@turf/bbox.md) ^5.1.5
- [geojson-vt](https://npm.io/package/geojson-vt.md) ^3.0.0
- [@turf/random](https://npm.io/package/@turf/random.md) ^5.1.0
- [@mapbox/tilebelt](https://npm.io/package/@mapbox/tilebelt.md) ^1.0.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.1 (latest) — 2018-06-11
- 1.0.1 — 2017-12-15

## README

# store-mvt

![Travis-ci build status](https://travis-ci.org/SKalt/store-mvt.svg?branch=master)
![npm version](https://badge.fury.io/js/store-mvt.svg)

> A module to slice and store [mapbox vector tiles (.mvt)](https://www.mapbox.com/vector-tiles/specification) from within Node.js.

## Installation
from npm : `npm install [--save[-dev]] store-mvt`

from github:
```
git clone https://github.com/SKalt/store-mvt.git path/to/target/dir
// to use it
const {storeMvt} = require('path/to/target/dir/src/index.js');
```

## usage
```{js}
const toMvt = require('store-mvt');
const geojsonVt = require('geojson-vt');
const supercluster = require('supercluster');

const clusterIndex = supercluster(/* options */);
clusterIndex.load(/* a giant array of geojson point features */);
const geojsonIndex = geojsonVt(/* geojson, options*/);

// save the .mvt pyramid to a directory:
toMvt(
  {layer_name: clusterIndex, other_layer_name: geojsonIndex},
  {//options
    ext: '.pbf' // the file extension to use for each tile,
    target: './pyramid', // a path to a directory to store the z/x/y tiles
  }
).then(()=>console.log('done!'));
```
### How it works
It recursively slices tiles from an input min to max zoom.

### Related tools
- [PostGIS's `ST_AsMVT`](/https://postgis.net/docs/ST_AsMVT.html) creates `.mvt` pyramids like this does.
- [`tippecanoe`](https://github.com/mapbox/tippecanoe) intelligently compresses
geojson to `.mbtiles`
- [`mbutil`/`mb-util`](https://github.com/mapbox/mbutil) stores directories of `.mvt` like `store-mvt` outputs as `.mbtiles`


## development
Contributions are welcome!

---
_Source: https://npm.io/package/store-mvt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._