Skip to content

mapbox/mapbox-upload-validate

Repository files navigation

Build Status Coverage Status

mapbox-upload-validate

Validate that a file can be uploaded to Mapbox

Install

$ npm install -g @mapbox/mapbox-upload-validate

Configuration

By default file metadata has a 60.0Kb limit. You can override this value with the LIMITS_MAX_METADATA environment variable. See https://github.com/mapbox/mapbox-upload-limits for additional configuration.

Usage

$ mapbox-upload-validate /path/to/data/file

Where /path/to/data/file is the path to a file.

There are three possible results:

  • Valid: process exit 0 and logs the file's path to stdout
  • Invalid: process exit 3, nothing is logged to stdout, and a validation error is printed to stderr
  • Unexpected: something unexpected happened and we could not confirm whether or not the file is valid. Process exit 1 with nothing printed to stdout and an error message printed to stderr

The following types of files are supported for upload to Mapbox.com:

  • Mbtiles
  • GeoTIFF
  • Zipped Shapefile
  • GeoJSON
  • TopoJSON
  • GPX
  • KML
  • TileJSON
  • tm2z
  • Serialtiles

Run tests

Setup your environment with some variables:

  • MapboxAccessToken: for access to mapbox.com

Then

npm test

About

Validate that files can be uploaded to mapbox.com

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published