@neaps/tide-predictor 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
 [](https://app.fossa.com/projects/git%2Bgithub.com%2Fneaps%2Ftide-predictor?ref=badge_shield)
|
|
2
2
|
|
|
3
3
|
# Tide predictor
|
|
4
4
|
|
|
@@ -40,13 +40,13 @@ const constituents = [
|
|
|
40
40
|
phase_local: 313.7,
|
|
41
41
|
amplitude: 2.687,
|
|
42
42
|
name: 'M2',
|
|
43
|
-
speed: 28.984104
|
|
44
|
-
}
|
|
43
|
+
speed: 28.984104,
|
|
44
|
+
},
|
|
45
45
|
//....there are usually many, read the docs
|
|
46
46
|
]
|
|
47
47
|
|
|
48
48
|
const highLowTides = tidePrediction(constituents, {
|
|
49
|
-
phaseKey: 'phase_GMT'
|
|
49
|
+
phaseKey: 'phase_GMT',
|
|
50
50
|
}).getExtremesPrediction(new Date('2019-01-01'), new Date('2019-01-10'))
|
|
51
51
|
```
|
|
52
52
|
|
|
@@ -76,8 +76,8 @@ const tides = tidePrediction(constituents).getExtremesPrediction({
|
|
|
76
76
|
labels: {
|
|
77
77
|
//optional human-readable labels
|
|
78
78
|
high: 'High tide',
|
|
79
|
-
low: 'Low tide'
|
|
80
|
-
}
|
|
79
|
+
low: 'Low tide',
|
|
80
|
+
},
|
|
81
81
|
})
|
|
82
82
|
```
|
|
83
83
|
|
|
@@ -90,13 +90,13 @@ const tides = tidePrediction(constituents).getExtremesPrediction({
|
|
|
90
90
|
offset: {
|
|
91
91
|
height_offset: {
|
|
92
92
|
high: 1,
|
|
93
|
-
low: 2
|
|
93
|
+
low: 2,
|
|
94
94
|
},
|
|
95
95
|
time_offset: {
|
|
96
96
|
high: 1,
|
|
97
|
-
low: 2
|
|
98
|
-
}
|
|
99
|
-
}
|
|
97
|
+
low: 2,
|
|
98
|
+
},
|
|
99
|
+
},
|
|
100
100
|
})
|
|
101
101
|
```
|
|
102
102
|
|
|
@@ -128,7 +128,7 @@ Gives you the predicted water level at a specific time.
|
|
|
128
128
|
|
|
129
129
|
```javascript
|
|
130
130
|
const waterLevel = tidePrediction(constituents).getWaterLevelAtTime({
|
|
131
|
-
time: new Date()
|
|
131
|
+
time: new Date(),
|
|
132
132
|
})
|
|
133
133
|
```
|
|
134
134
|
|