Home

Awesome

is-sea

Travis CI Codecov npm npm version npm dependencies npm dev dependencies

🌊 Check whether a geographic coordinate is in the sea or not on the earth.

<p align="center"> <a href="http://simonepri.github.io/is-sea/"><img src="https://raw.githubusercontent.com/simonepri/is-sea/master/demo/index.png" width="700"/></a> </p> <p align="center">Click on the map to see a live preview.</p>

Synopsis

Given the latitude and longitude coordinates this package returns whether the point fall into a sea/ocean or not.

The package internally uses @geo-maps/earth-seas map with 10m resolution. The accuracy of the map has not been tested but the demo allows you to actually test it manually by just clicking on the map to see what it returns.

Do you believe that this is useful? If so, <a href="#start-of-content">support us with a ⭐️</a>!

Install

$ npm install --save is-sea

Usage

You can query any (lat,lng) pair on the earth.

const isSea = require('is-sea');

// Query a point in Italy.
isSea.get(41.9028, 12.4964);
// => false

// Query a point somewhere in Atlantic Ocean.
isSea.get(40, -40);
// => true

API

get(lat, lng) ⇒ <code>Array.<string></code>

Returns wheather the given point is in the sea or not.

Returns: <code>Array.<string></code> - True if the point is in the sea, false otherwise.

ParamTypeDescription
lat<code>number</code>The latitude of the point.
lng<code>number</code>The longitude of the point.

Related

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.