@angelrove/forecast-utils 1.1.10 → 1.1.12

package/README.md

@@ -379,7 +379,7 @@ Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
 Custom hook to fetch current weather data from OpenMeteo API.
 
 **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)  
-**Returns**: <code>ForecastData</code> - -  
+**Returns**: <code>ForecastData</code> - {data, isLoading, isError, apiUrl}  
 
 | Param | Type |
 | --- | --- |
@@ -397,7 +397,7 @@ Custom hook to fetch daily forecast (10 days) data from OpenMeteo API.
 https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitude=-4.5108962&forecast_days=10&daily=weathercode
 
 **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)  
-**Returns**: <code>ForecastData</code> - -  
+**Returns**: <code>ForecastData</code> - {data, isLoading, isError, apiUrl}  
 
 | Param | Type |
 | --- | --- |
@@ -414,7 +414,7 @@ https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitu
 Custom hook to fetch hourly forecast data for a given location and number of days from OpenMeteo API.
 
 **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)  
-**Returns**: <code>ForecastData</code> - -  
+**Returns**: <code>ForecastData</code> - {data, isLoading, isError, apiUrl}  
 
 | Param | Type | Description |
 | --- | --- | --- |

package/dist/types/OpenMeteo/current/useForecastCurrent.d.ts

@@ -4,7 +4,7 @@
  * @param {number} lat
  * @param {number} lon
  * @param {number} refreshIntervalMin
- * @returns {ForecastData} -
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
  * @memberof module:OpenMeteo
  */
 export function useForecastCurrent(lat: number, lon: number, refreshIntervalMin?: number): ForecastData;

package/dist/types/OpenMeteo/daily/useForecastDaily.d.ts

@@ -1,11 +1,12 @@
 /**
  * Custom hook to fetch daily forecast (10 days) data from OpenMeteo API.
+ *
  * https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitude=-4.5108962&forecast_days=10&daily=weathercode
  *
  * @param {number} lat
  * @param {number} lon
  * @param {number} refreshIntervalMin
- * @returns {ForecastData} -
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
  * @memberof module:OpenMeteo
  */
 export function useForecastDaily(lat: number, lon: number, refreshIntervalMin?: number): ForecastData;

package/dist/types/OpenMeteo/hourly/useForecastHourly.d.ts

@@ -3,7 +3,7 @@
  *
  * @param {{ latitude: number, longitude: number }} location
  * @param {number} dayNum Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
- * @returns {ForecastData} -
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
  * @memberof module:OpenMeteo
  */
 export function useForecastHourly(location: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Jose Angel Romero Vegas",
   "name": "@angelrove/forecast-utils",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "Utilities for obtaining weather and astronomy forecast data.",
   "license": "MIT",
   "publishConfig": {
@@ -39,9 +39,10 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
-    "jsdoc-to-markdown": "^9.1.1",
     "@types/react": "^19.1.5",
-    "@types/react-dom": "^19.1.5"
+    "@types/react-dom": "^19.1.5",
+    "jsdoc-to-markdown": "^9.1.1",
+    "typescript": "^5.8.3"
   },
   "dependencies": {}
 }

package/src/OpenMeteo/current/useForecastCurrent.js

@@ -10,7 +10,7 @@ import transformer from "./transformer.js";
  * @param {number} lat
  * @param {number} lon
  * @param {number} refreshIntervalMin
- * @returns {ForecastData} -
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
  * @memberof module:OpenMeteo
  */
 export function useForecastCurrent(lat, lon, refreshIntervalMin = 0) {

package/src/OpenMeteo/daily/useForecastDaily.js

@@ -6,12 +6,13 @@ import transformer from "./transformer.js";
 
 /**
  * Custom hook to fetch daily forecast (10 days) data from OpenMeteo API.
+ *
  * https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitude=-4.5108962&forecast_days=10&daily=weathercode
  *
  * @param {number} lat
  * @param {number} lon
  * @param {number} refreshIntervalMin
- * @returns {ForecastData} -
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
  * @memberof module:OpenMeteo
  */
 export function useForecastDaily(lat, lon, refreshIntervalMin = 0) {

package/src/OpenMeteo/hourly/useForecastHourly.js

@@ -9,7 +9,7 @@ import { fetchParams } from "./fetchParams.js";
  *
  * @param {{ latitude: number, longitude: number }} location
  * @param {number} dayNum Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
- * @returns {ForecastData} -
+ * @returns {ForecastData} {data, isLoading, isError, apiUrl}
  * @memberof module:OpenMeteo
  */
 export function useForecastHourly(location, dayNum) {

package/dist/types/astronomy/types.d.ts

@@ -1,36 +0,0 @@
-export type AstroPosition = {
-    altitude: number;
-    azimuth: number;
-    direction: string;
-    direction_full: string;
-};
-export type LocalTimeData = {
-    /**
-     * - The local time.
-     */
-    time: Date;
-    /**
-     * - The formatted local time string.
-     */
-    timeStr: string;
-    /**
-     * - The timezone name.
-     */
-    timezone: string;
-    /**
-     * - The timezone ID.
-     */
-    timezoneId: string;
-    /**
-     * - The UTC offset in hours.
-     */
-    offset: number;
-    /**
-     * - The sign of the offset ('+' or '-').
-     */
-    offsetSign: string;
-    /**
-     * - The DST offset in hours.
-     */
-    dstOffset: number;
-};