s2-tools
v0.1.8TypeScript
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
0/weekUpdated 1 years agoSee LICENSE file.Unpacked: 14.3 MB
Published by Craig OConnor
npm install s2-tools
s2-tools
About
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
Install
``bash`NPM
npm install s2-toolsPNPM
pnpm add s2-toolsYarn
yarn add s2-toolsBun
bun add s2-tools
Components
> 💡 NOTE: The sizes are estimates and can change based on how you use them. Click the module link for documentation and more precise guides on file cost.
$3
| Main Modules | Size | Description |
| ------------------------ | ----------------------------- | ---------------------------------------------------------------- |
| [toJSON] | ![To JSON Badge][toJSONBadge] | Convert any Reader to JSON data. |
| [toTiles] | ![FT Badge][toTilesBadge] | Convert any Reader to vector and/or raster tiles. |
[toJSON]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/converters/toJSON.md
[toJSONBadge]: https://deno.bundlejs.com/badge?q=s2-tools&treeshake=[{+toJSON,toJSONLD,BufferReader+}]
[toTiles]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/converters/toTiles.md
[toTilesBadge]: https://deno.bundlejs.com/badge?q=s2-tools&treeshake=[{+toTiles,BufferReader+}]
$3
| Main Modules | Size | Description |
| ------------------------ | ----------------------------- | ---------------------------------------------------------------- |
| [externalSort] | ![ES Badge][esBadge] | Sort large files with uint64 keys |
| [kv] | ![KV Badge][kvBadge] | Collection of tools using the filesystem to read and write data. |
| [multiMap] | ![MM Badge][mmBadge] | Collection of tools using the filesystem to read and write data. |
| [vector] | ![Vec Badge][vecBadge] | Collection of tools using the filesystem to read and write data. |
[externalSort]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/externalSort.md
[esBadge]: /assets/badges/external-sort-gzip-cover.svg
[kv]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/kv.md
[kvBadge]: /assets/badges/kv-gzip-cover.svg
[multiMap]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/multimap.md
[mmBadge]: /assets/badges/multimap-gzip-cover.svg
[vector]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/vector.md
[vecBadge]: /assets/badges/vector-gzip-cover.svg
---
Development
$3
You need the tool tarpaulin to generate the coverage report. Install it using the following command:
`bash`
cargo install cargo-tarpaulin
The bacon coverage tool is used to generate the coverage report. To utilize the pycobertura package for a prettier coverage report, install it using the following command:
`bash`
pip install pycobertura
$3
To run the tests, use the following command:
`bashTYPESCRIPT
basic test
bun run testlive testing
bun run test:dev
RUST
basic test
cargo test
live testing
bacon test
`
$3
To generate the coverage report, use the following command:
bash
cargo tarpaulin
faster
cargo tarpaulin --color always --skip-clean
bacon
bacon coverage # or type l inside the tool
``