is-sea
v0.3.1
Published
Check whether a geographic coordinate is in the sea or not on the earth.
Downloads
117
Maintainers
Readme
is-sea
🌊 Check whether a geographic coordinate is in the sea or not on the earth.
Click on the map for a live preview.
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
The package internally uses @geo-maps/earth-seas map with 10m resolution.
API
get(lat, lng) ⇒ Array.<string>
Returns wheather the given point is in the sea or not.
Returns: Array.<string> - True if the point is in the sea, false otherwise.
| Param | Type | Description | | --- | --- | --- | | lat | number | The latitude of the point. | | lng | number | The longitude of the point. |
Authors
- Simone Primarosa - simonepri
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.