consider solidifying tilesource API as a prototype
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 540
- Forks
- 106
- PR merge metrics
- No merged PRs in 30d
Description
During some discussion in gis-devs slack, it was pointed out that not all tilelive Tilesource implementations have the full api (tilelive-mapnik implements getGrid, while tilelive-bridge does not. And API.md suggests that getGrid is standard for Tilesources).
It might be nice if we have a Tilesource function that stubs all expected methods on it's prototype, and rework existing Tilesources to inherit the prototype. This ensures that even if a source doesn't fully implement the Tilesource API, the stubs at least exist. I think this also solidifies expectations around what should be implemented by a custom Tilesource, and how to start building a custom Tilesource.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading API.md and comparing the Tilesource implementations, especially tilelive-mapnik and tilelive-bridge, to identify the documented methods and current differences. Define the expected prototype stubs and update existing Tilesources to use it; done means custom sources expose the expected API consistently and relevant tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100