Neaps 0.1.0
Release Tides & Currents
Introduce new package that bundles @neaps/tide-predictor and @neaps/tide-database into an easier to use pre-configured tide prediction engine.
import { getExtremesPrediction } from 'neaps'
const prediction = getExtremesPrediction({
latitude: 26.7, // or `lat`
longitude: -80.05, // or `lng` or `lon`
start: new Date('2025-12-17'),
end: new Date('2025-12-18'),
datum: 'MLLW', // optional, defaults to MLLW if available
})
console.log(extremes)
// {
// datum: 'MLLW',
// station: {
// id: '8723214',
// name: 'Fort Lauderdale, FL',
// // ...
// },
// distance: 12.3,
// predictions: [
// { time: 2019-01-01T03:12:00.000Z, level: 3.2, high: true, low: false, label: 'High' },
// { time: 2019-01-01T09:45:00.000Z, level: 0.5, high: false, low: true, label: 'Low' },
// ]
// }