neaps 0.3.0 → 0.3.1

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.
Files changed (3) hide show
  1. package/dist/index.d.cts +77 -36
  2. package/dist/index.d.ts +76 -35
  3. package/package.json +2 -2
package/dist/index.d.cts CHANGED
@@ -1,6 +1,7 @@
1
+ import * as _neaps_tide_predictor0 from "@neaps/tide-predictor";
2
+ import { ExtremesInput, TimeSpan } from "@neaps/tide-predictor";
1
3
  import * as _neaps_tide_database0 from "@neaps/tide-database";
2
4
  import { NearOptions, NearestOptions, Station } from "@neaps/tide-database";
3
- import { ExtremesInput, TimeSpan } from "@neaps/tide-predictor";
4
5
 
5
6
  //#region src/index.d.ts
6
7
  type Units = "meters" | "feet";
@@ -29,26 +30,34 @@ type WaterLevelOptions = {
29
30
  * })
30
31
  */
31
32
  declare function getExtremesPrediction(options: NearestOptions & ExtremesOptions): {
32
- datum: any;
33
- units: any;
33
+ datum: string | undefined;
34
+ units: Units;
34
35
  station: Station;
35
36
  distance: number | undefined;
36
- extremes: any;
37
+ extremes: _neaps_tide_predictor0.Extreme[];
37
38
  };
38
39
  /**
39
40
  * Get timeline prediction using the nearest station to the given position.
40
41
  */
41
42
  declare function getTimelinePrediction(options: NearestOptions & TimelineOptions): {
42
- datum: any;
43
- units: any;
43
+ datum: string | undefined;
44
+ units: Units;
44
45
  station: Station;
45
46
  distance: number | undefined;
46
- timeline: any;
47
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
47
48
  };
48
49
  /**
49
50
  * Get water level at a specific time using the nearest station to the given position.
50
51
  */
51
- declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): any;
52
+ declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): {
53
+ time: Date;
54
+ hour: number;
55
+ level: number;
56
+ datum: string | undefined;
57
+ units: Units;
58
+ station: Station;
59
+ distance: number | undefined;
60
+ };
52
61
  /**
53
62
  * Find the nearest station to the given position.
54
63
  */
@@ -62,28 +71,36 @@ declare function nearestStation(options: NearestOptions): {
62
71
  units,
63
72
  ...options
64
73
  }: ExtremesOptions): {
65
- datum: any;
66
- units: any;
74
+ datum: string | undefined;
75
+ units: Units;
67
76
  station: Station;
68
77
  distance: number | undefined;
69
- extremes: any;
78
+ extremes: _neaps_tide_predictor0.Extreme[];
70
79
  };
71
80
  getTimelinePrediction({
72
81
  datum,
73
82
  units,
74
83
  ...options
75
84
  }: TimelineOptions): {
76
- datum: any;
77
- units: any;
85
+ datum: string | undefined;
86
+ units: Units;
78
87
  station: Station;
79
88
  distance: number | undefined;
80
- timeline: any;
89
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
81
90
  };
82
91
  getWaterLevelAtTime({
83
92
  time,
84
93
  datum,
85
94
  units
86
- }: WaterLevelOptions): any;
95
+ }: WaterLevelOptions): {
96
+ time: Date;
97
+ hour: number;
98
+ level: number;
99
+ datum: string | undefined;
100
+ units: Units;
101
+ station: Station;
102
+ distance: number | undefined;
103
+ };
87
104
  id: string;
88
105
  name: string;
89
106
  continent: string;
@@ -133,28 +150,36 @@ declare function stationsNear(options: NearOptions): {
133
150
  units,
134
151
  ...options
135
152
  }: ExtremesOptions): {
136
- datum: any;
137
- units: any;
153
+ datum: string | undefined;
154
+ units: Units;
138
155
  station: Station;
139
156
  distance: number | undefined;
140
- extremes: any;
157
+ extremes: _neaps_tide_predictor0.Extreme[];
141
158
  };
142
159
  getTimelinePrediction({
143
160
  datum,
144
161
  units,
145
162
  ...options
146
163
  }: TimelineOptions): {
147
- datum: any;
148
- units: any;
164
+ datum: string | undefined;
165
+ units: Units;
149
166
  station: Station;
150
167
  distance: number | undefined;
151
- timeline: any;
168
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
152
169
  };
153
170
  getWaterLevelAtTime({
154
171
  time,
155
172
  datum,
156
173
  units
157
- }: WaterLevelOptions): any;
174
+ }: WaterLevelOptions): {
175
+ time: Date;
176
+ hour: number;
177
+ level: number;
178
+ datum: string | undefined;
179
+ units: Units;
180
+ station: Station;
181
+ distance: number | undefined;
182
+ };
158
183
  id: string;
159
184
  name: string;
160
185
  continent: string;
@@ -203,28 +228,36 @@ declare function findStation(query: string): {
203
228
  units,
204
229
  ...options
205
230
  }: ExtremesOptions): {
206
- datum: any;
207
- units: any;
231
+ datum: string | undefined;
232
+ units: Units;
208
233
  station: Station;
209
234
  distance: number | undefined;
210
- extremes: any;
235
+ extremes: _neaps_tide_predictor0.Extreme[];
211
236
  };
212
237
  getTimelinePrediction({
213
238
  datum,
214
239
  units,
215
240
  ...options
216
241
  }: TimelineOptions): {
217
- datum: any;
218
- units: any;
242
+ datum: string | undefined;
243
+ units: Units;
219
244
  station: Station;
220
245
  distance: number | undefined;
221
- timeline: any;
246
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
222
247
  };
223
248
  getWaterLevelAtTime({
224
249
  time,
225
250
  datum,
226
251
  units
227
- }: WaterLevelOptions): any;
252
+ }: WaterLevelOptions): {
253
+ time: Date;
254
+ hour: number;
255
+ level: number;
256
+ datum: string | undefined;
257
+ units: Units;
258
+ station: Station;
259
+ distance: number | undefined;
260
+ };
228
261
  id: string;
229
262
  name: string;
230
263
  continent: string;
@@ -270,28 +303,36 @@ declare function useStation(station: Station, distance?: number): {
270
303
  units,
271
304
  ...options
272
305
  }: ExtremesOptions): {
273
- datum: any;
274
- units: any;
306
+ datum: string | undefined;
307
+ units: Units;
275
308
  station: Station;
276
309
  distance: number | undefined;
277
- extremes: any;
310
+ extremes: _neaps_tide_predictor0.Extreme[];
278
311
  };
279
312
  getTimelinePrediction({
280
313
  datum,
281
314
  units,
282
315
  ...options
283
316
  }: TimelineOptions): {
284
- datum: any;
285
- units: any;
317
+ datum: string | undefined;
318
+ units: Units;
286
319
  station: Station;
287
320
  distance: number | undefined;
288
- timeline: any;
321
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
289
322
  };
290
323
  getWaterLevelAtTime({
291
324
  time,
292
325
  datum,
293
326
  units
294
- }: WaterLevelOptions): any;
327
+ }: WaterLevelOptions): {
328
+ time: Date;
329
+ hour: number;
330
+ level: number;
331
+ datum: string | undefined;
332
+ units: Units;
333
+ station: Station;
334
+ distance: number | undefined;
335
+ };
295
336
  id: string;
296
337
  name: string;
297
338
  continent: string;
package/dist/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import * as _neaps_tide_database0 from "@neaps/tide-database";
2
2
  import { NearOptions, NearestOptions, Station } from "@neaps/tide-database";
3
+ import * as _neaps_tide_predictor0 from "@neaps/tide-predictor";
3
4
  import { ExtremesInput, TimeSpan } from "@neaps/tide-predictor";
4
5
 
5
6
  //#region src/index.d.ts
@@ -29,26 +30,34 @@ type WaterLevelOptions = {
29
30
  * })
30
31
  */
31
32
  declare function getExtremesPrediction(options: NearestOptions & ExtremesOptions): {
32
- datum: any;
33
- units: any;
33
+ datum: string | undefined;
34
+ units: Units;
34
35
  station: Station;
35
36
  distance: number | undefined;
36
- extremes: any;
37
+ extremes: _neaps_tide_predictor0.Extreme[];
37
38
  };
38
39
  /**
39
40
  * Get timeline prediction using the nearest station to the given position.
40
41
  */
41
42
  declare function getTimelinePrediction(options: NearestOptions & TimelineOptions): {
42
- datum: any;
43
- units: any;
43
+ datum: string | undefined;
44
+ units: Units;
44
45
  station: Station;
45
46
  distance: number | undefined;
46
- timeline: any;
47
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
47
48
  };
48
49
  /**
49
50
  * Get water level at a specific time using the nearest station to the given position.
50
51
  */
51
- declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): any;
52
+ declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): {
53
+ time: Date;
54
+ hour: number;
55
+ level: number;
56
+ datum: string | undefined;
57
+ units: Units;
58
+ station: Station;
59
+ distance: number | undefined;
60
+ };
52
61
  /**
53
62
  * Find the nearest station to the given position.
54
63
  */
@@ -62,28 +71,36 @@ declare function nearestStation(options: NearestOptions): {
62
71
  units,
63
72
  ...options
64
73
  }: ExtremesOptions): {
65
- datum: any;
66
- units: any;
74
+ datum: string | undefined;
75
+ units: Units;
67
76
  station: Station;
68
77
  distance: number | undefined;
69
- extremes: any;
78
+ extremes: _neaps_tide_predictor0.Extreme[];
70
79
  };
71
80
  getTimelinePrediction({
72
81
  datum,
73
82
  units,
74
83
  ...options
75
84
  }: TimelineOptions): {
76
- datum: any;
77
- units: any;
85
+ datum: string | undefined;
86
+ units: Units;
78
87
  station: Station;
79
88
  distance: number | undefined;
80
- timeline: any;
89
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
81
90
  };
82
91
  getWaterLevelAtTime({
83
92
  time,
84
93
  datum,
85
94
  units
86
- }: WaterLevelOptions): any;
95
+ }: WaterLevelOptions): {
96
+ time: Date;
97
+ hour: number;
98
+ level: number;
99
+ datum: string | undefined;
100
+ units: Units;
101
+ station: Station;
102
+ distance: number | undefined;
103
+ };
87
104
  id: string;
88
105
  name: string;
89
106
  continent: string;
@@ -133,28 +150,36 @@ declare function stationsNear(options: NearOptions): {
133
150
  units,
134
151
  ...options
135
152
  }: ExtremesOptions): {
136
- datum: any;
137
- units: any;
153
+ datum: string | undefined;
154
+ units: Units;
138
155
  station: Station;
139
156
  distance: number | undefined;
140
- extremes: any;
157
+ extremes: _neaps_tide_predictor0.Extreme[];
141
158
  };
142
159
  getTimelinePrediction({
143
160
  datum,
144
161
  units,
145
162
  ...options
146
163
  }: TimelineOptions): {
147
- datum: any;
148
- units: any;
164
+ datum: string | undefined;
165
+ units: Units;
149
166
  station: Station;
150
167
  distance: number | undefined;
151
- timeline: any;
168
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
152
169
  };
153
170
  getWaterLevelAtTime({
154
171
  time,
155
172
  datum,
156
173
  units
157
- }: WaterLevelOptions): any;
174
+ }: WaterLevelOptions): {
175
+ time: Date;
176
+ hour: number;
177
+ level: number;
178
+ datum: string | undefined;
179
+ units: Units;
180
+ station: Station;
181
+ distance: number | undefined;
182
+ };
158
183
  id: string;
159
184
  name: string;
160
185
  continent: string;
@@ -203,28 +228,36 @@ declare function findStation(query: string): {
203
228
  units,
204
229
  ...options
205
230
  }: ExtremesOptions): {
206
- datum: any;
207
- units: any;
231
+ datum: string | undefined;
232
+ units: Units;
208
233
  station: Station;
209
234
  distance: number | undefined;
210
- extremes: any;
235
+ extremes: _neaps_tide_predictor0.Extreme[];
211
236
  };
212
237
  getTimelinePrediction({
213
238
  datum,
214
239
  units,
215
240
  ...options
216
241
  }: TimelineOptions): {
217
- datum: any;
218
- units: any;
242
+ datum: string | undefined;
243
+ units: Units;
219
244
  station: Station;
220
245
  distance: number | undefined;
221
- timeline: any;
246
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
222
247
  };
223
248
  getWaterLevelAtTime({
224
249
  time,
225
250
  datum,
226
251
  units
227
- }: WaterLevelOptions): any;
252
+ }: WaterLevelOptions): {
253
+ time: Date;
254
+ hour: number;
255
+ level: number;
256
+ datum: string | undefined;
257
+ units: Units;
258
+ station: Station;
259
+ distance: number | undefined;
260
+ };
228
261
  id: string;
229
262
  name: string;
230
263
  continent: string;
@@ -270,28 +303,36 @@ declare function useStation(station: Station, distance?: number): {
270
303
  units,
271
304
  ...options
272
305
  }: ExtremesOptions): {
273
- datum: any;
274
- units: any;
306
+ datum: string | undefined;
307
+ units: Units;
275
308
  station: Station;
276
309
  distance: number | undefined;
277
- extremes: any;
310
+ extremes: _neaps_tide_predictor0.Extreme[];
278
311
  };
279
312
  getTimelinePrediction({
280
313
  datum,
281
314
  units,
282
315
  ...options
283
316
  }: TimelineOptions): {
284
- datum: any;
285
- units: any;
317
+ datum: string | undefined;
318
+ units: Units;
286
319
  station: Station;
287
320
  distance: number | undefined;
288
- timeline: any;
321
+ timeline: _neaps_tide_predictor0.TimelinePoint[];
289
322
  };
290
323
  getWaterLevelAtTime({
291
324
  time,
292
325
  datum,
293
326
  units
294
- }: WaterLevelOptions): any;
327
+ }: WaterLevelOptions): {
328
+ time: Date;
329
+ hour: number;
330
+ level: number;
331
+ datum: string | undefined;
332
+ units: Units;
333
+ station: Station;
334
+ distance: number | undefined;
335
+ };
295
336
  id: string;
296
337
  name: string;
297
338
  continent: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "neaps",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Tide predictions",
5
5
  "keywords": [
6
6
  "tides",
@@ -34,7 +34,7 @@
34
34
  "prepack": "npm run build"
35
35
  },
36
36
  "dependencies": {
37
- "@neaps/tide-database": "0.3",
37
+ "@neaps/tide-database": "0.4",
38
38
  "@neaps/tide-predictor": "^0.5.0"
39
39
  }
40
40
  }