# s2

> [![Build Status](https://travis-ci.org/mapbox/node-s2.svg?branch=master)](https://travis-ci.org/mapbox/node-s2)

Latest version **0.5.0** (published 2016-11-07) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install s2
pnpm add s2
yarn add s2
bun add s2
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2016-11-07 |
| First published | 2014-05-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 86 |
| Author | Tom MacWright |
| Maintainers | aaronlidman, ansis, camilleanne, dthompson, gretacb, ingalls, jfirebaugh, kkaefer, mapbox-admin, miccolis, morganherlocker, rclark, springmeyer, tmcw, willwhite, yhahn |

## Links

- npm: https://www.npmjs.com/package/s2
- Repository: https://github.com/mapbox/node-s2
- Homepage: https://github.com/mapbox/node-s2#readme
- Issues: https://github.com/mapbox/node-s2/issues
- npm.io page: https://npm.io/package/s2

## Dependencies (2)

- [nan](https://npm.io/package/nan.md) ^2.4.0
- [node-pre-gyp](https://npm.io/package/node-pre-gyp.md) ^0.5.19

## Recent versions

- 0.5.0 (latest) — 2016-11-07
- 0.4.0 — 2015-02-22
- 0.3.9 — 2014-08-06
- 0.3.8 — 2014-07-28
- 0.3.7 — 2014-07-23
- 0.3.6 — 2014-07-23
- 0.3.5 — 2014-07-23
- 0.3.4 — 2014-07-22
- 0.3.3 — 2014-07-22
- 0.3.2 — 2014-07-22
- 0.3.1 — 2014-05-20
- 0.3.0 — 2014-05-12
- 0.2.1 — 2014-05-12
- 0.2.0 — 2014-05-09
- 0.1.0 — 2014-05-07
- … 1 more at https://npm.io/package/s2/versions

## README

[![Build Status](https://travis-ci.org/mapbox/node-s2.svg?branch=master)](https://travis-ci.org/mapbox/node-s2)

# node-s2

Bindings for the [S2 Geometry Library](https://code.google.com/p/s2-geometry-library/) into
[node.js](http://nodejs.org/).

S2 is a library that does spherical math over the world, and supports a very
fancy Hilbert curve-related indexing scheme. S2 has no documentation besides
source comments and [this presentation](https://cloudup.com/cVR0jOEufLR).
Notably it's used for [MongoDB](https://www.mongodb.org/)'s [2dsphere index](http://docs.mongodb.org/manual/core/2dsphere/),
as well as in [viewfinderco](https://github.com/viewfinderco/viewfinder)'s
[DynamoDB](http://aws.amazon.com/dynamodb/)-powered database. [s2map.com](http://s2map.com/)
also demonstrates one of the killer features of the library, 'coverings', which
are intelligently computed groups of cells that can be used to index geometries.

## Example

```js
var s2 = require('s2');

var ll = new s2.S2LatLng(0, 0);
ll.isValid(); // true
var normalized = ll.normalized(); // true
var pt = ll.toPoint();
```

## Build

    npm install
    npm build . --build-from-source
    npm test

## Geojson

node-s2 is a low level s2 wrapper. If you are simply looking to get geojson into s2, you should check out [geojson-cover](https://github.com/mapbox/geojson-cover).

## [Documentation: API.md](API.md)

## Notes

Some of the S2 API is not wrapped because it isn't meant to be exposed in this way,
and is blocked from wrapping by [DISALLOW_COPY_AND_ASSIGN](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Copy_Constructors).

* S2CellUnion
* S2Loop
* S2Polyline
* S2Polygon
* S2RegionCoverer
* S2RegionIntersection

## See Also

* [s2-geometry-javascript](https://github.com/jonatkins/s2-geometry-javascript) - an incomplete port of S2 to JavaScript.
* [gos2](https://code.google.com/p/gos2/) - very incomplete port to Go
* [viewfinder built a python wrapper](https://github.com/viewfinderco/third_party/blob/master/python-package/s2-0.2.tar.gz)
* [s2-geometry-php](https://github.com/eelf/s2-geometry-library-php) - another very incomplete port to PHP
* [interview with david blackman](http://www.fastcolabs.com/3007394/open-company/how-foursquare-building-humane-map-framework-rival-googles)

---
_Source: https://npm.io/package/s2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._