https://github.com/simonepri/is-sea
🌊 Check whether a geographic coordinate is in the sea or not on the earth.
https://github.com/simonepri/is-sea
geojson land maps nodejs
Last synced: about 1 year ago
JSON representation
🌊 Check whether a geographic coordinate is in the sea or not on the earth.
- Host: GitHub
- URL: https://github.com/simonepri/is-sea
- Owner: simonepri
- License: mit
- Created: 2017-12-05T19:26:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-08T01:33:05.000Z (almost 4 years ago)
- Last Synced: 2024-04-18T14:22:25.800Z (about 2 years ago)
- Topics: geojson, land, maps, nodejs
- Language: JavaScript
- Homepage:
- Size: 2.03 MB
- Stars: 47
- Watchers: 3
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# is-sea
[](https://travis-ci.org/simonepri/is-sea) [](https://codecov.io/gh/simonepri/is-sea) [](https://www.npmjs.com/package/is-sea) [](https://www.npmjs.com/package/is-sea) [](https://david-dm.org/simonepri/is-sea) [](https://david-dm.org/simonepri/is-sea#info=devDependencies)
> 🌊 Check whether a geographic coordinate is in the sea or not on the earth.
Click on the map to see a live preview.
## 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](https://github.com/simonepri/geo-maps/blob/master/info/earth-seas.md) map with 10m resolution.
The accuracy of the map has not been tested but the [demo](http://simonepri.github.io/is-sea/) 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, support us with a ⭐️!
## Install
```bash
$ npm install --save is-sea
```
## Usage
You can query any `(lat,lng)` pair on the earth.
```javascript
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) ⇒ 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. |
## Related
* [country-iso](https://github.com/simonepri/country-iso): 🗺 Get ISO 3166-1 alpha-3 country code from geographic coordinates.
## Authors
* **Simone Primarosa** - [simonepri](https://github.com/simonepri)
See also the list of [contributors](https://github.com/simonepri/is-sea/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.