A TileStrata plugin for storing / retrieving tiles from disk. It can either act as a cache or as a provider. When using it for caching, make sure to use different directories for each layer (e.g. "tiles/layer_a", "tiles/layer_b"). If given a
maxage, it will check the modification time of a tile and return null if it's too old. If
maxage=0, caching behavior will be completely disabled.
$ npm install tilestrata-disk --save
var disk = ;// cache: cache tiles to diskserver;// cache: cache with maxageserver;// cache: cache with maxage function (advanced)server;// cache: custom directory layoutserver;// cache: custom directory layout (via callback)server;
// provider: serve pre-existing / pre-sliced tiles off diskserver;
Some sample values of
maxage: null // no age checking: permanent caching (default)maxage: 0 // disable cache completely (both reading and writing)maxage: 3600 // one hour
If using TileStrata 0.6.0 and above, you can also specify a
refreshage parameter that indicates how old a tile can be before TileStrata should refresh it. This option should be used in conjunction with
maxage. The purpose is best illustrated by an example:
With this configuration, if the cache finds a tile that is two days old, it will serve the tile from cache while telling TileStrata to build a new tile in the background for the next person (more info here). Some sample values of
refreshage: null // never refresh (default)refreshage: 0 // always refresh in background after hitsrefreshage: 1800 // half hour
Before submitting pull requests, please update the tests and make sure they all pass.
$ npm test
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.