@globalfishingwatch/ocean-areas
v2.0.3
Published
A TypeScript library for handling and querying ocean areas, including Exclusive Economic Zones (EEZs), Marine Protected Areas (MPAs), and general ocean regions. This library provides functionality for searching, localizing, and determining geographical re
Keywords
Readme
Ocean Areas Library
A TypeScript library for handling and querying ocean areas, including Exclusive Economic Zones (EEZs), Marine Protected Areas (MPAs), and general ocean regions. This library provides functionality for searching, localizing, and determining geographical relationships between points and ocean areas.
Installation
yarn add @globalfishingwatch/ocean-areasFeatures
- Search ocean areas by name
- Get ocean areas by geographical coordinates
- Localization support (English, Spanish, French)
- Distance-based area queries
- Overlapping area detection
- Bounding box calculations
Usage
Import
import { getOceanAreas } from '@globalfishingwatch/ocean-areas'
const areas = await getOceanAreas(
{
latitude: -3,
longitude: 25,
},
{
locale: 'en', // Optional: Filter by area types
types: ['eez', 'mpa'], // Optional: Filter by area types
}
)Build and publish
nx build ocean-areas
nx publish ocean-areasDependencies
@turf/*: For geographical calculationsmatch-sorter: For fuzzy searching- GeoJSON types and utilities
License
MIT
