@angelrove/forecast-utils 1.1.10 → 1.1.11

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 CHANGED
@@ -379,7 +379,7 @@ Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
379
379
  Custom hook to fetch current weather data from OpenMeteo API.
380
380
 
381
381
  **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)
382
- **Returns**: <code>ForecastData</code> - -
382
+ **Returns**: <code>ForecastData</code> - {data, isLoading, isError, apiUrl}
383
383
 
384
384
  | Param | Type |
385
385
  | --- | --- |
@@ -397,7 +397,7 @@ Custom hook to fetch daily forecast (10 days) data from OpenMeteo API.
397
397
  https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitude=-4.5108962&forecast_days=10&daily=weathercode
398
398
 
399
399
  **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)
400
- **Returns**: <code>ForecastData</code> - -
400
+ **Returns**: <code>ForecastData</code> - {data, isLoading, isError, apiUrl}
401
401
 
402
402
  | Param | Type |
403
403
  | --- | --- |
@@ -414,7 +414,7 @@ https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitu
414
414
  Custom hook to fetch hourly forecast data for a given location and number of days from OpenMeteo API.
415
415
 
416
416
  **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)
417
- **Returns**: <code>ForecastData</code> - -
417
+ **Returns**: <code>ForecastData</code> - {data, isLoading, isError, apiUrl}
418
418
 
419
419
  | Param | Type | Description |
420
420
  | --- | --- | --- |
@@ -4,7 +4,7 @@
4
4
  * @param {number} lat
5
5
  * @param {number} lon
6
6
  * @param {number} refreshIntervalMin
7
- * @returns {ForecastData} -
7
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
8
8
  * @memberof module:OpenMeteo
9
9
  */
10
10
  export function useForecastCurrent(lat: number, lon: number, refreshIntervalMin?: number): ForecastData;
@@ -5,7 +5,7 @@
5
5
  * @param {number} lat
6
6
  * @param {number} lon
7
7
  * @param {number} refreshIntervalMin
8
- * @returns {ForecastData} -
8
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
9
9
  * @memberof module:OpenMeteo
10
10
  */
11
11
  export function useForecastDaily(lat: number, lon: number, refreshIntervalMin?: number): ForecastData;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * @param {{ latitude: number, longitude: number }} location
5
5
  * @param {number} dayNum Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
6
- * @returns {ForecastData} -
6
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
7
7
  * @memberof module:OpenMeteo
8
8
  */
9
9
  export function useForecastHourly(location: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "Jose Angel Romero Vegas",
3
3
  "name": "@angelrove/forecast-utils",
4
- "version": "1.1.10",
4
+ "version": "1.1.11",
5
5
  "description": "Utilities for obtaining weather and astronomy forecast data.",
6
6
  "license": "MIT",
7
7
  "publishConfig": {
@@ -10,7 +10,7 @@ import transformer from "./transformer.js";
10
10
  * @param {number} lat
11
11
  * @param {number} lon
12
12
  * @param {number} refreshIntervalMin
13
- * @returns {ForecastData} -
13
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
14
14
  * @memberof module:OpenMeteo
15
15
  */
16
16
  export function useForecastCurrent(lat, lon, refreshIntervalMin = 0) {
@@ -11,7 +11,7 @@ import transformer from "./transformer.js";
11
11
  * @param {number} lat
12
12
  * @param {number} lon
13
13
  * @param {number} refreshIntervalMin
14
- * @returns {ForecastData} -
14
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
15
15
  * @memberof module:OpenMeteo
16
16
  */
17
17
  export function useForecastDaily(lat, lon, refreshIntervalMin = 0) {
@@ -9,7 +9,7 @@ import { fetchParams } from "./fetchParams.js";
9
9
  *
10
10
  * @param {{ latitude: number, longitude: number }} location
11
11
  * @param {number} dayNum Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
12
- * @returns {ForecastData} -
12
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
13
13
  * @memberof module:OpenMeteo
14
14
  */
15
15
  export function useForecastHourly(location, dayNum) {