npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tilelive-decorator

v4.0.1

Published

Load vector tiles from another source and decorate them with properties from redis.

Downloads

3

Readme

tilelive-decorator

Circle CI

Load vector tiles from a tilelive source and decorate them with properties from redis. So if you use tilelive-s3 it can load tiles from s3, and add properties to features from redis.

usage

with tilelive

Tilelive decorator registers several tilelive protocols:

  • decorator+s3: for reading tiles from S3
  • decorator+mbtiles: for reading tiles from an mbtiles
var tilelive = require('tilelive');
var TileliveDecorator = require('tilelive-decorator');
var TileliveS3 = require('tilelive-s3');

TileliveDecorator.registerProtocols(tilelive);
TileliveS3.registerProtocols(tilelive);

tilelive.load('decorator+s3://test/{z}/{x}/{y}?key=id&sourceProps={"keep":["id","name"]}&redis=redis://localhost:6379', function(err, source) {
  // source.getTile(z, x, y, callback);
});

manually

var TileliveDecorator = require('tilelive-decorator');

var uri = 'decorator+s3://test/{z}/{x}/{y}?key=id&sourceProps={"keep":["id","name"]}&redis=redis://localhost:6379'
new TileliveDecorator(uri, function (err, source) {
  // source.getTile(z, x, y, callback);
});

options

key (required) - specifies what property in the source tiles will be matched to keys in redis.

sourceProps - a json object, specifying properties to keep from the source tile, and properties that are required to exist on features in the source tile. example: {"keep": ["id", "class"], "required": ["rating"]}. If all required properties don't exist on a feature, that feature is filtered out.

redisProps - a json object, specifying properties to keep from redis records, and properties that are required to exist on redis records. example: {"keep": ["congestion"], "required": ["speed"]}. If all required properties don't exist on a record, that record is filtered out and no new properties will be applied to features that match the record key.

outputProps - a json object, specifying properties to keep in the output tile after decoration, and properties that are required to exist on features in the output tile. example: {"keep": ["class", "congestion"], "required": ["congestion"]}. If all required properties don't exist on a feature, that feature is filtered out.

redis - a redis connection string, e.g. redis://localhost:6379.

hashes - If hashes=true is included, redis keys are treated as hash types as opposed to stringified JSON data in string type keys. In this case hget is used instead of the default get commands.

development

setup

Tests and benchmarks require a local redis server

brew install redis
git clone https://github.com/mapbox/tilelive-decorator
cd tilelive-decorator
npm install
redis-server --save "" &

benchmarks

redis-cli flushall && node benchmark.js

tests

redis-cli flushall && npm test