API.md

migrate(style)

Migrate a Mapbox GL Style to the latest version.

Parameters

parameter	type	description
style	object	a Mapbox GL Style

Example

var fs = require('fs');
var migrate = require('mapbox-gl-style-lint').migrate;
var style = fs.readFileSync('./style.json', 'utf8');
fs.writeFileSync('./style.json', JSON.stringify(migrate(style)));

Returns Object, a migrated style

validate(str)

Validate a Mapbox GL Style given as a string of JSON. Returns an array that can contain any number of objects representing errors. Each object has members line (number) and message (string).

This expects the style to be given as a string, rather than an object, so that it can return accurate line numbers for errors. if you happen to have a JSON object already, use validate.parsed() instead.

Parameters

parameter	type	description
str	string	a Mapbox GL Style as a string

Example

var fs = require('fs');
var validate = require('mapbox-gl-style-lint').validate;
var style = fs.readFileSync('./style.json', 'utf8');
var errors = validate(style);

Returns Array.<Object>, an array of errors

validate.parsed(style)

Validate a Mapbox GL Style as a JSON object against the given style reference. Returns results in the same format as validate.

Parameters

parameter	type	description
style	Object	a Mapbox GL Style

Example

var fs = require('fs');
var validate = require('mapbox-gl-style-lint').validate;
var spec = require('mapbox-gl-style-spec');
var style = require('./style.json');
var errors = validate.parsed(style, spec.v7);

Returns Array.<Object>, an array of errors

validate.latest(style)

Validate a Mapbox GL Style given a JSON object against the latest version of the style spec. Returns results in the same format as validate.

Parameters

parameter	type	description
style	Object	a Mapbox GL Style

Example

var fs = require('fs');
var validate = require('mapbox-gl-style-lint').validate;
var style = require('./style.json');
var errors = validate.latest(style);

Returns Array.<Object>, an array of errors