https://github.com/sharedstreets/sharedstreets-download-tile
SharedStreets Tile Downloader
https://github.com/sharedstreets/sharedstreets-download-tile
Last synced: about 1 month ago
JSON representation
SharedStreets Tile Downloader
- Host: GitHub
- URL: https://github.com/sharedstreets/sharedstreets-download-tile
- Owner: sharedstreets
- License: mit
- Created: 2018-03-12T19:56:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-07T13:32:29.000Z (about 8 years ago)
- Last Synced: 2025-01-25T10:28:06.716Z (over 1 year ago)
- Language: TypeScript
- Size: 2.37 MB
- Stars: 1
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SharedStreets Tile Downloader (JavaScript)
[](https://badge.fury.io/js/sharedstreets-api)
[](https://travis-ci.org/sharedstreets/sharedstreets-api)
Interact directly with SharedStreet's tile API.
## Install
**In Node.js**
```bash
$ yarn add sharedstreets-api
```
**CommonJS**
```js
const sharedstreetsApi = require('sharedstreets-api');
```
**Typescript**
```js
import * as sharedstreetsApi from 'sharedstreets-api';
```
## In Browser
For a full list of web examples, check out [SharedStreets examples](https://github.com/sharedstreets/sharedstreets-examples).
## CLI
Usage:
$ sharedstreets-download-tile
Options:
--tile tile [x,y,zoom]
--layer layer (geometry|intersection|metadata|reference)
Examples:
$ sharedstreets-download-tile --tile [1186,1466,12] --layer "geometry" > "12-1186-1466.geometry.pbf"
## API
#### Table of Contents
- [downloadTile](#downloadtile)
### downloadTile
Download Tile
**Parameters**
- `tile` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Tile [x, y, z]
- `layer` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Layer (geometry|intersection|metadata|reference)
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Optional parameter (optional, default `{}`)
- `options.output` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Output (json|pbf) (optional, default `"pbf"`)
**Examples**
```javascript
const tile = [1186, 1466, 12];
const layer = "geometry";
sharedstreetsApi.downloadTile(tile, layer).then(data => {
data // => PBF Buffer
})
```
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Buffer](https://nodejs.org/api/buffer.html)>** PBF Buffer