API.md

config

src/server.js:66-85

Configuration

Type: Object

Properties

• cors boolean? enables CORS
• port number port to run on
• proxy boolean? when true proxy header fields will be trusted
• tilesURL string tiles endpoint URL
• postgresql postgresql PostgreSQL connection information
• redis redis? Redis connection information
• tilesets tilesets tilesets description

postgresql

src/server.js:66-85

PostgreSQL Connection

Type: Object

Properties

• host string name of host to connect to
• port number port number to connect to at the server host
• database string the database name
• user string PostgreSQL user name to connect as
• password string password to be used if the server demands password authentication.

redis

src/server.js:66-85

Redis Connection

Type: Object

Properties

• host string name of host to connect to
• port number port number to connect to at the server host

tilesets

src/server.js:66-85

Tilesets

Type: Object<string, tileset>

tileset

src/server.js:66-85

Tileset

Type: Object

Properties

• table string name of table containing data
• geometry_field string? name of geometry column
• srid number? geometry column srid
• simplify_geometries boolean? whether to automatically reduce input vertices

martin

src/server.js:66-85

Mapbox Vector Tiles Server

Parameters

• config config

Returns Koa koa instance