@neaps/tide-predictor 0.2.1 → 0.4.0

package/README.md

@@ -20,28 +20,25 @@ npm install @neaps/tide-predictor
 `@neaps/tide-predictor` requires that you [provide your own tidal harmonics information](#constituent-object) to generate a prediction. For a complete tide prediction solution, including finding nearby stations and their harmonics, check out the [`neaps` package](https://github.com/neaps/neaps).
 
 ```typescript
-import TidePredictor from '@neaps/tide-predictor'
+import TidePredictor from "@neaps/tide-predictor";
 
 const constituents = [
   {
-    phase_GMT: 98.7,
-    phase_local: 313.7,
+    phase: 98.7,
     amplitude: 2.687,
-    name: 'M2',
-    speed: 28.984104
-  }
+    name: "M2",
+    speed: 28.984104,
+  },
   //....there are usually many, read the docs
-]
+];
 
-const highLowTides = TidePredictor(constituents, {
-  phaseKey: 'phase_GMT'
-}).getExtremesPrediction({
-  start: new Date('2019-01-01'),
-  end: new Date('2019-01-10')
-})
+const highLowTides = TidePredictor(constituents).getExtremesPrediction({
+  start: new Date("2019-01-01"),
+  end: new Date("2019-01-10"),
+});
 ```
 
-Note that, for now, Neaps **will not** do any timezone corrections. This means you need to pass date objects that align with whatever timezone the constituents are in.
+Note that all times internally are evaluated as UTC, so be sure to specify a timezone offset when constructing dates if you want to work in a local time. For example, to get tides for January 1st, 2019 in New York (UTC-5), create a date `new Date('2019-01-01T00:00:00-05:00')`
 
 ## Tide prediction object
 
@@ -49,7 +46,6 @@ Calling `tidePredictor` will generate a new tide prediction object. It accepts t
 
 - `constituents` - An array of [constituent objects](#constituent-object)
 - `options` - An object with one of:
-  - `phaseKey` - The name of the parameter within constituents that is considered the "phase" because many constituent datum come with multiple phases (in the case of NOAA's data, they are `phase_local` and `phase_GMT`).
   - `offset` - A value to add to **all** values predicted. This is useful if you want to, for example, offset tides by mean high water, etc.
 
 ### Tide prediction methods
@@ -61,17 +57,17 @@ The returned tide prediction object has various methods. All of these return reg
 Returns the predicted high and low tides between a start and end date.
 
 ```typescript
-const startDate = new Date()
-const endDate = new Date(startDate + 3 * 24 * 60 * 60 * 1000)
+const startDate = new Date();
+const endDate = new Date(startDate + 3 * 24 * 60 * 60 * 1000);
 const tides = TidePredictor(constituents).getExtremesPrediction({
   start: startDate,
   end: endDate,
   labels: {
     //optional human-readable labels
-    high: 'High tide',
-    low: 'Low tide'
-  }
-})
+    high: "High tide",
+    low: "Low tide",
+  },
+});
 ```
 
 If you want predictions for a subservient station, first set the reference station in the prediction, and pass the [subservient station offests](#subservient-station) to the `getExtremesPrediction` method:
@@ -83,14 +79,14 @@ const tides = TidePredictor(constituents).getExtremesPrediction({
   offset: {
     height_offset: {
       high: 1,
-      low: 2
+      low: 2,
     },
     time_offset: {
       high: 1,
-      low: 2
-    }
-  }
-})
+      low: 2,
+    },
+  },
+});
 ```
 
 ##### Options
@@ -121,8 +117,8 @@ Gives you the predicted water level at a specific time.
 
 ```typescript
 const waterLevel = TidePredictor(constituents).getWaterLevelAtTime({
-  time: new Date()
-})
+  time: new Date(),
+});
 ```
 
 ##### Options
@@ -146,19 +142,19 @@ Tidal constituents should be an array of objects with at least:
 
 - `name` - **string** - The NOAA constituent name, all upper-case.
 - `amplitude` - **float** - The constituent amplitude
-- `[phase]` - **float** - The phase of the constituent. Because several services provide different phase values, you can choose which one to use when building your tide prediction.
+- `phase` - **float** - The phase of the constituent.
 
-```
+```json
 [
   {
-    name: '[constituent name]',
-    amplitude: 1.3,
-    phase: 1.33
+    "name": "[constituent name]",
+    "amplitude": 1.3,
+    "phase": 1.33
   },
   {
-    name: '[constituent name 2]',
-    amplitude: 1.3,
-    phase: 1.33
+    "name": "[constituent name 2]",
+    "amplitude": 1.3,
+    "phase": 1.33
   }
 ]
 ```