@angelrove/forecast-utils 1.1.8 → 1.1.10

package/README.md

@@ -39,10 +39,11 @@ Importante!:
 * [Astronomy/MoonCalc](#module_Astronomy/MoonCalc)
     * [.phasesES](#module_Astronomy/MoonCalc.phasesES) : <code>Object.&lt;string, string&gt;</code>
     * [.data(latitude, longitude, [date], [language])](#module_Astronomy/MoonCalc.data) ⇒ <code>MoonData</code>
-    * [.dataExt(latitude, longitude, [date], [language])](#module_Astronomy/MoonCalc.dataExt) ⇒ <code>Object</code>
+    * [.dataExt(latitude, longitude, [date], [language])](#module_Astronomy/MoonCalc.dataExt) ⇒ <code>MoonDataExt</code>
     * [.emoji(latitude, longitude, [date])](#module_Astronomy/MoonCalc.emoji) ⇒ <code>string</code>
     * [.times(latitude, longitude, timezoneId, date)](#module_Astronomy/MoonCalc.times) ⇒ <code>Object</code>
     * [.getUpOrDown(altitude, highest)](#module_Astronomy/MoonCalc.getUpOrDown) ⇒ <code>string</code>
+    * [.MoonDataExt](#module_Astronomy/MoonCalc.MoonDataExt) : <code>Object</code>
     * [.MoonData](#module_Astronomy/MoonCalc.MoonData) : <code>Object</code>
 
 
@@ -62,6 +63,7 @@ Mapa de fases lunares.
 
 ### Astronomy/MoonCalc.data(latitude, longitude, [date], [language]) ⇒ <code>MoonData</code>
 **Kind**: static method of [<code>Astronomy/MoonCalc</code>](#module_Astronomy/MoonCalc)  
+**Returns**: <code>MoonData</code> - Moon info object  
 
 | Param | Type | Default |
 | --- | --- | --- |
@@ -75,11 +77,12 @@ Mapa de fases lunares.
 
 <a name="module_Astronomy/MoonCalc.dataExt"></a>
 
-### Astronomy/MoonCalc.dataExt(latitude, longitude, [date], [language]) ⇒ <code>Object</code>
+### Astronomy/MoonCalc.dataExt(latitude, longitude, [date], [language]) ⇒ <code>MoonDataExt</code>
 Información de la luna para una fecha y hora dadas.
 La fecha y hora se devolverán en la zona horaria local.
 
 **Kind**: static method of [<code>Astronomy/MoonCalc</code>](#module_Astronomy/MoonCalc)  
+**Returns**: <code>MoonDataExt</code> - Full information  
 
 | Param | Type | Default |
 | --- | --- | --- |
@@ -95,7 +98,7 @@ La fecha y hora se devolverán en la zona horaria local.
 
 ### Astronomy/MoonCalc.emoji(latitude, longitude, [date]) ⇒ <code>string</code>
 **Kind**: static method of [<code>Astronomy/MoonCalc</code>](#module_Astronomy/MoonCalc)  
-**Returns**: <code>string</code> - - Emoji of the moon phase  
+**Returns**: <code>string</code> - Emoji of the moon phase  
 
 | Param | Type | Default |
 | --- | --- | --- |
@@ -110,6 +113,7 @@ La fecha y hora se devolverán en la zona horaria local.
 
 ### Astronomy/MoonCalc.times(latitude, longitude, timezoneId, date) ⇒ <code>Object</code>
 **Kind**: static method of [<code>Astronomy/MoonCalc</code>](#module_Astronomy/MoonCalc)  
+**Returns**: <code>Object</code> - Moon times  
 
 | Param | Type |
 | --- | --- |
@@ -133,6 +137,28 @@ La fecha y hora se devolverán en la zona horaria local.
 | highest | <code>Date</code> | 
 
 
+* * *
+
+<a name="module_Astronomy/MoonCalc.MoonDataExt"></a>
+
+### Astronomy/MoonCalc.MoonDataExt : <code>Object</code>
+**Kind**: static typedef of [<code>Astronomy/MoonCalc</code>](#module_Astronomy/MoonCalc)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| date | <code>string</code> | 
+| time | <code>string</code> | 
+| illumination | <code>string</code> | 
+| phase | <code>string</code> | 
+| phaseId | <code>string</code> | 
+| emoji | <code>string</code> | 
+| parallacticAngle | <code>number</code> | 
+| angle | <code>number</code> | 
+| position | <code>AstroPosition</code> | 
+| next | <code>Object</code> | 
+
+
 * * *
 
 <a name="module_Astronomy/MoonCalc.MoonData"></a>
@@ -178,6 +204,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 ### Astronomy/SunCalc.all(date, latitude, longitude, timezoneId) ⇒ <code>Object</code>
 **Kind**: static method of [<code>Astronomy/SunCalc</code>](#module_Astronomy/SunCalc)  
+**Returns**: <code>Object</code> - { sunTimes: Object, sunPosition: Object, sunPhase: string }  
 
 | Param | Type |
 | --- | --- |
@@ -193,6 +220,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 ### Astronomy/SunCalc.times(date, latitude, longitude, timezoneId) ⇒ <code>Object</code>
 **Kind**: static method of [<code>Astronomy/SunCalc</code>](#module_Astronomy/SunCalc)  
+**Returns**: <code>Object</code> - { date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }  
 
 | Param | Type |
 | --- | --- |
@@ -208,7 +236,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 ### Astronomy/SunCalc.getSolarTime(date, lng, offsetSign, offset) ⇒ <code>string</code>
 **Kind**: static method of [<code>Astronomy/SunCalc</code>](#module_Astronomy/SunCalc)  
-**Returns**: <code>string</code> - - Local time in "HH:mm" format  
+**Returns**: <code>string</code> - Local time in "HH:mm" format  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -224,6 +252,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 ### Astronomy/SunCalc.position(latitude, longitude) ⇒ <code>Object</code>
 **Kind**: static method of [<code>Astronomy/SunCalc</code>](#module_Astronomy/SunCalc)  
+**Returns**: <code>Object</code> - {date: string, azimuth: number, direction: string, direction_full: string, altitude: number, zenith: number, declination: number}  
 
 | Param | Type |
 | --- | --- |
@@ -237,7 +266,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 ### Astronomy/SunCalc.getIsNight(lat, lon, timezoneId, date, dateStr) ⇒ <code>boolean</code>
 **Kind**: static method of [<code>Astronomy/SunCalc</code>](#module_Astronomy/SunCalc)  
-**Returns**: <code>boolean</code> - - true if it's night, false otherwise  
+**Returns**: <code>boolean</code> - true if it's night, false otherwise  
 
 | Param | Type |
 | --- | --- |
@@ -254,7 +283,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 ### Astronomy/SunCalc.getPhase(altitude, noon) ⇒ <code>string</code>
 **Kind**: static method of [<code>Astronomy/SunCalc</code>](#module_Astronomy/SunCalc)  
-**Returns**: <code>string</code> - - The phase of the sun based on its altitude  
+**Returns**: <code>string</code> - The phase of the sun based on its altitude  
 
 | Param | Type |
 | --- | --- |
@@ -271,6 +300,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 * [Geolocation](#module_Geolocation)
     * [.exports.getGeolocation()](#module_Geolocation.exports.getGeolocation) ⇒ <code>Promise.&lt;{latitude: number, longitude: number, formatted\_address: string}&gt;</code>
     * [.exports.timeFromLocation(apiKey, lat, lng)](#module_Geolocation.exports.timeFromLocation) ⇒ <code>Promise.&lt;(any\|LocalTimeData)&gt;</code>
+    * [.LocalTimeData](#module_Geolocation.LocalTimeData) : <code>Object</code>
 
 
 * * *
@@ -281,6 +311,7 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 Get the current geolocation of the device and reverse geocode it to get the address.
 
 **Kind**: static method of [<code>Geolocation</code>](#module_Geolocation)  
+**Returns**: <code>Promise.&lt;{latitude: number, longitude: number, formatted\_address: string}&gt;</code> - Promise  
 **Throws**:
 
 - <code>Error</code> If geolocation is not supported or permission is denied.
@@ -294,10 +325,10 @@ Get the current geolocation of the device and reverse geocode it to get the addr
 Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
 
 **Kind**: static method of [<code>Geolocation</code>](#module_Geolocation)  
-**Returns**: <code>Promise.&lt;(any\|LocalTimeData)&gt;</code> - - An object containing the local time and timezone information:  
+**Returns**: <code>Promise.&lt;(any\|LocalTimeData)&gt;</code> - An object containing the local time and timezone information:  
 **Throws**:
 
-- <code>Error</code> - If the API request fails or returns an error status.
+- <code>Error</code> If the API request fails or returns an error status.
 
 
 | Param | Type | Description |
@@ -307,6 +338,25 @@ Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
 | lng | <code>number</code> |  |
 
 
+* * *
+
+<a name="module_Geolocation.LocalTimeData"></a>
+
+### Geolocation.LocalTimeData : <code>Object</code>
+**Kind**: static typedef of [<code>Geolocation</code>](#module_Geolocation)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| time | <code>Date</code> | The local time. |
+| timeStr | <code>string</code> | The formatted local time string. |
+| timezone | <code>string</code> | The timezone name. |
+| timezoneId | <code>string</code> | The timezone ID. |
+| offset | <code>number</code> | The UTC offset in hours. |
+| offsetSign | <code>string</code> | The sign of the offset ('+' or '-'). |
+| dstOffset | <code>number</code> | The DST offset in hours. |
+
+
 * * *
 
 <a name="module_OpenMeteo"></a>
@@ -314,20 +364,22 @@ Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
 ## OpenMeteo
 
 * [OpenMeteo](#module_OpenMeteo)
-    * [.exports.useForecastCurrent(lat, lon, refreshIntervalMin)](#module_OpenMeteo.exports.useForecastCurrent) ⇒ <code>Object</code>
-    * [.exports.useForecastDaily(lat, lon, refreshIntervalMin)](#module_OpenMeteo.exports.useForecastDaily) ⇒ <code>Object</code>
-    * [.exports.useForecastHourly(location, dayNum)](#module_OpenMeteo.exports.useForecastHourly) ⇒ <code>Object</code>
+    * [.exports.useForecastCurrent(lat, lon, refreshIntervalMin)](#module_OpenMeteo.exports.useForecastCurrent) ⇒ <code>ForecastData</code>
+    * [.exports.useForecastDaily(lat, lon, refreshIntervalMin)](#module_OpenMeteo.exports.useForecastDaily) ⇒ <code>ForecastData</code>
+    * [.exports.useForecastHourly(location, dayNum)](#module_OpenMeteo.exports.useForecastHourly) ⇒ <code>ForecastData</code>
     * [.exports.weatherSymbol(code, [precipitation], night, dark)](#module_OpenMeteo.exports.weatherSymbol) ⇒ <code>Object</code>
+    * [.ForecastData](#module_OpenMeteo.ForecastData) : <code>Object</code>
 
 
 * * *
 
 <a name="module_OpenMeteo.exports.useForecastCurrent"></a>
 
-### OpenMeteo.exports.useForecastCurrent(lat, lon, refreshIntervalMin) ⇒ <code>Object</code>
+### OpenMeteo.exports.useForecastCurrent(lat, lon, refreshIntervalMin) ⇒ <code>ForecastData</code>
 Custom hook to fetch current weather data from OpenMeteo API.
 
 **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)  
+**Returns**: <code>ForecastData</code> - -  
 
 | Param | Type |
 | --- | --- |
@@ -340,11 +392,12 @@ Custom hook to fetch current weather data from OpenMeteo API.
 
 <a name="module_OpenMeteo.exports.useForecastDaily"></a>
 
-### OpenMeteo.exports.useForecastDaily(lat, lon, refreshIntervalMin) ⇒ <code>Object</code>
+### OpenMeteo.exports.useForecastDaily(lat, lon, refreshIntervalMin) ⇒ <code>ForecastData</code>
 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> - -  
 
 | Param | Type |
 | --- | --- |
@@ -357,10 +410,11 @@ https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitu
 
 <a name="module_OpenMeteo.exports.useForecastHourly"></a>
 
-### OpenMeteo.exports.useForecastHourly(location, dayNum) ⇒ <code>Object</code>
+### OpenMeteo.exports.useForecastHourly(location, dayNum) ⇒ <code>ForecastData</code>
 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> - -  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -376,6 +430,7 @@ Custom hook to fetch hourly forecast data for a given location and number of day
 Get weather symbol and description based on the weather code.
 
 **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)  
+**Returns**: <code>Object</code> - { icon: string, description: string }  
 
 | Param | Type |
 | --- | --- |
@@ -385,6 +440,22 @@ Get weather symbol and description based on the weather code.
 | dark | <code>boolean</code> | 
 
 
+* * *
+
+<a name="module_OpenMeteo.ForecastData"></a>
+
+### OpenMeteo.ForecastData : <code>Object</code>
+**Kind**: static typedef of [<code>OpenMeteo</code>](#module_OpenMeteo)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| data | <code>any</code> | Forecast data |
+| isLoading | <code>boolean</code> | Loading state |
+| isError | <code>any</code> | Error state |
+| apiUrl | <code>string</code> | API URL |
+
+
 * * *
 
 <a name="module_Utils"></a>
@@ -400,7 +471,7 @@ Get weather symbol and description based on the weather code.
     * [.exports.getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow)](#module_Utils.exports.getWarningByDays) ⇒ <code>Object</code> \| <code>null</code>
     * [.exports.getWarning(precipitation, showers)](#module_Utils.exports.getWarning) ⇒ <code>Object</code> \| <code>null</code>
     * [.exports.WindArrow(props)](#module_Utils.exports.WindArrow)
-    * [.exports.windArrowTx(deg)](#module_Utils.exports.windArrowTx)
+    * [.exports.windArrowTx(deg)](#module_Utils.exports.windArrowTx) ⇒ <code>string</code>
     * [.exports.getWindLevel(speed)](#module_Utils.exports.getWindLevel) ⇒ <code>WindLevel</code> \| <code>null</code>
     * [.Compass](#module_Utils.Compass) : <code>Object</code>
     * [.AlertLevel](#module_Utils.AlertLevel) : <code>Object</code>
@@ -465,6 +536,7 @@ Ordered list of wind levels.
 Convert degrees to compass designation
 
 **Kind**: static method of [<code>Utils</code>](#module_Utils)  
+**Returns**: <code>Object</code> - {short: string, full: string}  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -480,6 +552,7 @@ Convert degrees to compass designation
 Get warning by today and tomorrow
 
 **Kind**: static method of [<code>Utils</code>](#module_Utils)  
+**Returns**: <code>Object</code> \| <code>null</code> - {{ levelNum: number, level: string, message: string, day: number } | null}  
 
 | Param | Type |
 | --- | --- |
@@ -497,6 +570,7 @@ Get warning by today and tomorrow
 Get warning by precipitation and showers
 
 **Kind**: static method of [<code>Utils</code>](#module_Utils)  
+**Returns**: <code>Object</code> \| <code>null</code> - {{ levelNum: number, level: string, message: string } | null}  
 
 | Param | Type |
 | --- | --- |
@@ -527,10 +601,11 @@ SVG arrow indicating wind direction.
 
 <a name="module_Utils.exports.windArrowTx"></a>
 
-### Utils.exports.windArrowTx(deg)
+### Utils.exports.windArrowTx(deg) ⇒ <code>string</code>
 Convert wind direction in degrees to an arrow representation.
 
 **Kind**: static method of [<code>Utils</code>](#module_Utils)  
+**Returns**: <code>string</code> - Arrow representation of the wind direction.  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -653,6 +728,7 @@ Returns a time as a formated string.
 Returns a now time as a formated string.
 
 **Kind**: static method of [<code>Utils/TimeDateStr</code>](#module_Utils/TimeDateStr)  
+**Returns**: <code>String</code> - now time as a formated string  
 
 | Param | Type | Default |
 | --- | --- | --- |

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

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

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

@@ -5,11 +5,7 @@
  * @param {number} lat
  * @param {number} lon
  * @param {number} refreshIntervalMin
- * @returns {{ data: any, isLoading: boolean, isError: any }}
+ * @returns {ForecastData} -
  * @memberof module:OpenMeteo
  */
-export function useForecastDaily(lat: number, lon: number, refreshIntervalMin?: number): {
-    data: any;
-    isLoading: boolean;
-    isError: any;
-};
+export function useForecastDaily(lat: number, lon: number, refreshIntervalMin?: number): ForecastData;

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

@@ -2,15 +2,11 @@
  * Custom hook to fetch hourly forecast data for a given location and number of days from OpenMeteo API.
  *
  * @param {{ latitude: number, longitude: number }} location
- * @param {number} dayNum - Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
- * @returns {{ data: any, isLoading: boolean, isError: any }}
+ * @param {number} dayNum Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
+ * @returns {ForecastData} -
  * @memberof module:OpenMeteo
  */
 export function useForecastHourly(location: {
     latitude: number;
     longitude: number;
-}, dayNum: number): {
-    data: any;
-    isLoading: boolean;
-    isError: any;
-};
+}, dayNum: number): ForecastData;

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

@@ -0,0 +1,18 @@
+export type ForecastData = {
+    /**
+     * - Forecast data
+     */
+    data: any;
+    /**
+     * - Loading state
+     */
+    isLoading: boolean;
+    /**
+     * - Error state
+     */
+    isError: any;
+    /**
+     * - API URL
+     */
+    apiUrl: string;
+};

package/dist/types/OpenMeteo/weatherSymbol/weatherSymbol.d.ts

@@ -6,6 +6,7 @@
  * @param {boolean} night
  * @param {boolean} dark
  * @returns {{ icon: string, description: string }}
+ * { icon: string, description: string }
  * @memberof module:OpenMeteo
  */
 export function weatherSymbol(code: any, precipitation?: number, night?: boolean, dark?: boolean): {

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

@@ -1,4 +1,25 @@
 export default MoonCalc;
+export type AstroPosition = {
+    altitude: number;
+    azimuth: number;
+    direction: string;
+    /**
+     * ``
+     */
+    direction_full: string;
+};
+export type MoonDataExt = {
+    date: string;
+    time: string;
+    illumination: string;
+    phase: string;
+    phaseId: string;
+    emoji: string;
+    parallacticAngle: number;
+    angle: number;
+    position: AstroPosition;
+    next: Object;
+};
 export type MoonData = {
     position: AstroPosition;
     next: {
@@ -18,7 +39,7 @@ declare namespace MoonCalc {
  * @param {number} longitude
  * @param {Date} [date=new Date()]
  * @param {string} [language=es-ES]
- * @returns {MoonData}
+ * @returns {MoonData} Moon info object
  * @memberof module:Astronomy/MoonCalc
  */
 declare function data(latitude: number, longitude: number, date?: Date, language?: string): MoonData;
@@ -30,27 +51,16 @@ declare function data(latitude: number, longitude: number, date?: Date, language
  * @param {number} longitude
  * @param {Date} [date=new Date()]
  * @param {string} [language=es-ES]
- * @returns {{ date: string, time: string, illumination: string, phase: string, phaseId: string, emoji: string, parallacticAngle: number, angle: number, position: AstroPosition, next: object }}
+ * @returns {MoonDataExt} Full information
  * @memberof module:Astronomy/MoonCalc
  */
-declare function dataExt(latitude: number, longitude: number, date?: Date, language?: string): {
-    date: string;
-    time: string;
-    illumination: string;
-    phase: string;
-    phaseId: string;
-    emoji: string;
-    parallacticAngle: number;
-    angle: number;
-    position: AstroPosition;
-    next: object;
-};
+declare function dataExt(latitude: number, longitude: number, date?: Date, language?: string): MoonDataExt;
 /**
  * @param {number} latitude
  * @param {number} longitude
  * @param {string} timezoneId
  * @param {Date} date
- * @returns {{rise: string, set: string, highest: string}}
+ * @returns {{rise: string, set: string, highest: string}} Moon times
  * @memberof module:Astronomy/MoonCalc
  */
 declare function times(latitude: number, longitude: number, timezoneId: string, date?: Date): {
@@ -62,7 +72,7 @@ declare function times(latitude: number, longitude: number, timezoneId: string,
  * @param {number} latitude
  * @param {number} longitude
  * @param {Date} [date=new Date()]
- * @returns {string} - Emoji of the moon phase
+ * @returns {string} Emoji of the moon phase
  * @memberof module:Astronomy/MoonCalc
  */
 declare function emoji(latitude: number, longitude: number, date?: Date): string;

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

@@ -12,12 +12,13 @@ declare namespace SunCalc {
  * @param {number} latitude
  * @param {number} longitude
  * @param {string} timezoneId
- * @returns {{ sunTimes: object, sunPosition: object, sunPhase: string }}
+ * @returns {{ sunTimes: Object, sunPosition: Object, sunPhase: string }}
+ * { sunTimes: Object, sunPosition: Object, sunPhase: string }
  * @memberof module:Astronomy/SunCalc
  */
 declare function all(date: Date, latitude: number, longitude: number, timezoneId: string): {
-    sunTimes: object;
-    sunPosition: object;
+    sunTimes: Object;
+    sunPosition: Object;
     sunPhase: string;
 };
 /**
@@ -26,6 +27,7 @@ declare function all(date: Date, latitude: number, longitude: number, timezoneId
  * @param {number} longitude
  * @param {string} timezoneId
  * @returns {{ date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }}
+ * { date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }
  * @memberof module:Astronomy/SunCalc
  */
 declare function times(date: Date, latitude: number, longitude: number, timezoneId: string): {
@@ -39,9 +41,9 @@ declare function times(date: Date, latitude: number, longitude: number, timezone
 /**
  * @param {Date} date
  * @param {number} lng
- * @param {string} offsetSign - "+" or "-"
- * @param {number} offset - UTC offset in hours
- * @returns {string} - Local time in "HH:mm" format
+ * @param {string} offsetSign "+" or "-"
+ * @param {number} offset UTC offset in hours
+ * @returns {string} Local time in "HH:mm" format
  * @memberof module:Astronomy/SunCalc
  */
 declare function getSolarTime(date: Date, lng: number, offsetSign: string, offset: number): string;
@@ -49,6 +51,7 @@ declare function getSolarTime(date: Date, lng: number, offsetSign: string, offse
  * @param {number} latitude
  * @param {number} longitude
  * @returns {{date: string, azimuth: number, direction: string, direction_full: string, altitude: number, zenith: number, declination: number}}
+ * {date: string, azimuth: number, direction: string, direction_full: string, altitude: number, zenith: number, declination: number}
  * @memberof module:Astronomy/SunCalc
  */
 declare function position(latitude: number, longitude: number, date?: Date, language?: string): {
@@ -66,14 +69,14 @@ declare function position(latitude: number, longitude: number, date?: Date, lang
  * @param {string} timezoneId
  * @param {number | Date} date
  * @param {string} dateStr
- * @returns {boolean} - true if it's night, false otherwise
+ * @returns {boolean} true if it's night, false otherwise
  * @memberof module:Astronomy/SunCalc
  */
 declare function getIsNight(lat: number, lon: number, timezoneId: string, date: number | Date, dateStr: string): boolean;
 /**
  * @param {number} altitude
  * @param {string} noon
- * @returns {string} - The phase of the sun based on its altitude
+ * @returns {string} The phase of the sun based on its altitude
  * @memberof module:Astronomy/SunCalc
  */
 declare function getPhase(altitude: number, noon: string): string;

package/dist/types/geolocation/getGeolocation.d.ts

@@ -1,7 +1,7 @@
 /**
  * Get the current geolocation of the device and reverse geocode it to get the address.
  *
- * @returns {Promise<{latitude: number, longitude: number, formatted_address: string}>}
+ * @returns {Promise<{latitude: number, longitude: number, formatted_address: string}>} Promise
  * @throws {Error} If geolocation is not supported or permission is denied.
  * @memberof module:Geolocation
  */

package/dist/types/geolocation/timeFromLocation.d.ts

@@ -1,11 +1,52 @@
+/**
+ * @memberof module:Geolocation
+ * @typedef {Object} LocalTimeData
+ * @property {Date} time - The local time.
+ * @property {string} timeStr - The formatted local time string.
+ * @property {string} timezone - The timezone name.
+ * @property {string} timezoneId - The timezone ID.
+ * @property {number} offset - The UTC offset in hours.
+ * @property {string} offsetSign - The sign of the offset ('+' or '-').
+ * @property {number} dstOffset - The DST offset in hours.
+ */
 /**
  * Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
  *
- * @param {string} apiKey - GoogleMaps API key.
+ * @param {string} apiKey GoogleMaps API key.
  * @param {number} lat
  * @param {number} lng
- * @returns {Promise<any | LocalTimeData>} - An object containing the local time and timezone information:
- * @throws {Error} - If the API request fails or returns an error status.
+ * @returns {Promise<any | LocalTimeData>} An object containing the local time and timezone information:
+ * @throws {Error} If the API request fails or returns an error status.
  * @memberof module:Geolocation
  */
 export function timeFromLocation(apiKey: string, lat: number, lng: number): Promise<any | LocalTimeData>;
+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;
+};

package/dist/types/utils/degreesToCompass.d.ts

@@ -3,7 +3,7 @@
  *
  * @param {number} degrees
  * @param {string} language - Language code ("en-US", "es-ES", "auto")
- * @returns {{short: string, full: string}}
+ * @returns {{short: string, full: string}} {short: string, full: string}
  * @memberof module:Utils
  */
 export function degreesToCompass(degrees: number, language?: string): {

package/dist/types/utils/timehelpers.d.ts

@@ -17,7 +17,7 @@ declare function dateFormat(date?: Date): string;
  * Returns a now time as a formated string.
  *
  * @param {boolean} sec
- * @returns {String}
+ * @returns {String} now time as a formated string
  * @memberof module:Utils/TimeDateStr
  */
 declare function nowString(sec?: boolean): string;

package/dist/types/utils/warning.d.ts

@@ -6,6 +6,7 @@
  * @param {number} showersSumToday
  * @param {number} showersSumTomorrow
  * @returns {{ levelNum: number, level: string, message: string, day: number } | null}
+ * {{ levelNum: number, level: string, message: string, day: number } | null}
  * @memberof module:Utils
  */
 export function getWarningByDays(precipitationSumToday: number, precipitationSumTomorrow: number, showersSumToday: number, showersSumTomorrow: number): {
@@ -21,6 +22,7 @@ export function getWarningByDays(precipitationSumToday: number, precipitationSum
  * @param {number} precipitation
  * @param {number} showers
  * @returns {{ levelNum: number, level: string, message: string } | null}
+ * {{ levelNum: number, level: string, message: string } | null}
  * @memberof module:Utils
  */
 export function getWarning(precipitation: number, showers: number): {

package/dist/types/utils/wind/windArrowTx.d.ts

@@ -1,10 +1,8 @@
-/**
- * Convert wind direction in degrees to an arrow representation.
- */
 /**
  * Convert wind direction in degrees to an arrow representation.
  *
  * @param {number} deg - Wind direction in degrees.
+ * @returns {string} Arrow representation of the wind direction.
  * @memberof module:Utils
  */
-export function windArrowTx(deg: number): "deg?" | "↓" | "↙" | "←" | "↖" | "↑" | "↗" | "→" | "↘" | undefined;
+export function windArrowTx(deg: number): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Jose Angel Romero Vegas",
   "name": "@angelrove/forecast-utils",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "Utilities for obtaining weather and astronomy forecast data.",
   "license": "MIT",
   "publishConfig": {

package/src/OpenMeteo/current/useForecastCurrent.js

@@ -1,7 +1,4 @@
-/**
- * Custom hook to fetch current weather data from OpenMeteo API.
- */
-
+// @ts-nocheck
 import useSWR from "swr";
 import { fetcher, getPath } from "../conf.js";
 import { fetchParams } from "./fetchParams.js";
@@ -13,7 +10,7 @@ import transformer from "./transformer.js";
  * @param {number} lat
  * @param {number} lon
  * @param {number} refreshIntervalMin
- * @returns {{ data: any, apiUrl: string, isLoading: boolean, isError: any }}
+ * @returns {ForecastData} -
  * @memberof module:OpenMeteo
  */
 export function useForecastCurrent(lat, lon, refreshIntervalMin = 0) {

package/src/OpenMeteo/daily/useForecastDaily.js

@@ -1,7 +1,4 @@
-/**
- * Custom hook to fetch daily forecast (10 days) data from OpenMeteo API.
- */
-
+// @ts-nocheck
 import useSWR from "swr";
 import { fetcher, getPath } from "../conf.js";
 import { fetchParams } from "./fetchParams.js";
@@ -14,7 +11,7 @@ import transformer from "./transformer.js";
  * @param {number} lat
  * @param {number} lon
  * @param {number} refreshIntervalMin
- * @returns {{ data: any, isLoading: boolean, isError: any }}
+ * @returns {ForecastData} -
  * @memberof module:OpenMeteo
  */
 export function useForecastDaily(lat, lon, refreshIntervalMin = 0) {
@@ -33,6 +30,7 @@ export function useForecastDaily(lat, lon, refreshIntervalMin = 0) {
   // Return --
   return {
     data: data ? transformer(data) : null,
+    apiUrl: apiUrl,
     isLoading,
     isError: error,
   };

package/src/OpenMeteo/hourly/useForecastHourly.js

@@ -1,7 +1,4 @@
-/**
- * Custom hook to fetch hourly forecast data for a given location and number of days from OpenMeteo API.
- */
-
+// @ts-nocheck
 import useSWR from "swr";
 import { fetcher, getPath } from "../conf.js";
 import { getDatesFromNumDays } from "../helpers.js";
@@ -11,8 +8,8 @@ import { fetchParams } from "./fetchParams.js";
  * Custom hook to fetch hourly forecast data for a given location and number of days from OpenMeteo API.
  *
  * @param {{ latitude: number, longitude: number }} location
- * @param {number} dayNum - Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
- * @returns {{ data: any, isLoading: boolean, isError: any }}
+ * @param {number} dayNum Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
+ * @returns {ForecastData} -
  * @memberof module:OpenMeteo
  */
 export function useForecastHourly(location, dayNum) {
@@ -37,6 +34,7 @@ export function useForecastHourly(location, dayNum) {
 
   return {
     data: data,
+    apiUrl: apiUrl,
     isLoading,
     isError: error,
   };

package/src/OpenMeteo/types.js

@@ -0,0 +1,8 @@
+/**
+ * @memberof module:OpenMeteo
+ * @typedef {Object} ForecastData
+ * @property {any} data - Forecast data
+ * @property {boolean} isLoading - Loading state
+ * @property {any} isError - Error state
+ * @property {string} apiUrl - API URL
+ */

package/src/OpenMeteo/weatherSymbol/weatherSymbol.js

@@ -1,7 +1,3 @@
-/**
- * Get weather symbol and description based on the weather code.
- */
-
 import { getWeatherCodeEntry } from "./lib/getWeatherCodeEntry.js";
 
 /**
@@ -12,6 +8,7 @@ import { getWeatherCodeEntry } from "./lib/getWeatherCodeEntry.js";
  * @param {boolean} night
  * @param {boolean} dark
  * @returns {{ icon: string, description: string }}
+ * { icon: string, description: string }
  * @memberof module:OpenMeteo
  */
 export function weatherSymbol(

package/src/astronomy/moon/MoonCalc.js

@@ -1,4 +1,3 @@
-// @ts-nocheck
 /**
  * MoonCalc for calculating moon times, positions, and phases.
  *
@@ -15,15 +14,6 @@ import SunCalc from "suncalc3";
 import TimeDateStr from "../../utils/timehelpers.js";
 import { parseBasicData } from "./parseBasicData.js";
 
-/**
- * @memberof module:Astronomy/MoonCalc
- * @typedef {Object} MoonData
- * @property {AstroPosition} position
- * @property {Object} next
- * @property {string} next.newMoon - Date of the next new moon.
- * @property {string} next.fullMoon - Date of the next full moon.
- */
-
 /**
  * MoonCalc.
  * @ignore
@@ -37,6 +27,39 @@ const MoonCalc = {
 };
 export default MoonCalc;
 
+/**
+ * @memberof module:Astronomy
+ * @typedef {Object} AstroPosition
+ * @property {number} altitude
+ * @property {number} azimuth
+ * @property {string} direction
+ * @property {string} direction_full``
+ */
+
+/**
+ * @memberof module:Astronomy/MoonCalc
+ * @typedef {Object} MoonDataExt
+ * @property {string} date
+ * @property {string} time
+ * @property {string} illumination
+ * @property {string} phase
+ * @property {string} phaseId
+ * @property {string} emoji
+ * @property {number} parallacticAngle
+ * @property {number} angle
+ * @property {AstroPosition} position
+ * @property {Object} next
+ */
+
+/**
+ * @memberof module:Astronomy/MoonCalc
+ * @typedef {Object} MoonData
+ * @property {AstroPosition} position
+ * @property {Object} next
+ * @property {string} next.newMoon - Date of the next new moon.
+ * @property {string} next.fullMoon - Date of the next full moon.
+ */
+
 /**
  * Mapa de fases lunares.
  * { phaseId, phaseName }
@@ -61,7 +84,7 @@ const phasesES = {
  * @param {number} longitude
  * @param {Date} [date=new Date()]
  * @param {string} [language=es-ES]
- * @returns {MoonData}
+ * @returns {MoonData} Moon info object
  * @memberof module:Astronomy/MoonCalc
  */
 function data(latitude, longitude, date = new Date(), language = "es-ES") {
@@ -80,7 +103,7 @@ function data(latitude, longitude, date = new Date(), language = "es-ES") {
  * @param {number} longitude
  * @param {Date} [date=new Date()]
  * @param {string} [language=es-ES]
- * @returns {{ date: string, time: string, illumination: string, phase: string, phaseId: string, emoji: string, parallacticAngle: number, angle: number, position: AstroPosition, next: object }}
+ * @returns {MoonDataExt} Full information
  * @memberof module:Astronomy/MoonCalc
  */
 function dataExt(latitude, longitude, date = new Date(), language = "es-ES") {
@@ -122,7 +145,7 @@ function dataExt(latitude, longitude, date = new Date(), language = "es-ES") {
  * @param {number} latitude
  * @param {number} longitude
  * @param {Date} [date=new Date()]
- * @returns {string} - Emoji of the moon phase
+ * @returns {string} Emoji of the moon phase
  * @memberof module:Astronomy/MoonCalc
  */
 function emoji(latitude, longitude, date = new Date()) {
@@ -135,7 +158,7 @@ function emoji(latitude, longitude, date = new Date()) {
  * @param {number} longitude
  * @param {string} timezoneId
  * @param {Date} date
- * @returns {{rise: string, set: string, highest: string}}
+ * @returns {{rise: string, set: string, highest: string}} Moon times
  * @memberof module:Astronomy/MoonCalc
  */
 function times(latitude, longitude, timezoneId, date = new Date()) {

package/src/astronomy/sun/SunCalc.js

@@ -35,7 +35,8 @@ export default SunCalc;
  * @param {number} latitude
  * @param {number} longitude
  * @param {string} timezoneId
- * @returns {{ sunTimes: object, sunPosition: object, sunPhase: string }}
+ * @returns {{ sunTimes: Object, sunPosition: Object, sunPhase: string }}
+ * { sunTimes: Object, sunPosition: Object, sunPhase: string }
  * @memberof module:Astronomy/SunCalc
  */
 function all(date, latitude, longitude, timezoneId) {
@@ -57,6 +58,7 @@ function all(date, latitude, longitude, timezoneId) {
  * @param {number} longitude
  * @param {string} timezoneId
  * @returns {{ date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }}
+ * { date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }
  * @memberof module:Astronomy/SunCalc
  */
 function times(date, latitude, longitude, timezoneId) {
@@ -81,9 +83,9 @@ function times(date, latitude, longitude, timezoneId) {
 /**
  * @param {Date} date
  * @param {number} lng
- * @param {string} offsetSign - "+" or "-"
- * @param {number} offset - UTC offset in hours
- * @returns {string} - Local time in "HH:mm" format
+ * @param {string} offsetSign "+" or "-"
+ * @param {number} offset UTC offset in hours
+ * @returns {string} Local time in "HH:mm" format
  * @memberof module:Astronomy/SunCalc
  */
 function getSolarTime(date, lng, offsetSign, offset) {
@@ -97,6 +99,7 @@ function getSolarTime(date, lng, offsetSign, offset) {
  * @param {number} latitude
  * @param {number} longitude
  * @returns {{date: string, azimuth: number, direction: string, direction_full: string, altitude: number, zenith: number, declination: number}}
+ * {date: string, azimuth: number, direction: string, direction_full: string, altitude: number, zenith: number, declination: number}
  * @memberof module:Astronomy/SunCalc
  */
 function position(latitude, longitude, date = new Date(), language = "es-ES") {
@@ -124,7 +127,7 @@ function position(latitude, longitude, date = new Date(), language = "es-ES") {
  * @param {string} timezoneId
  * @param {number | Date} date
  * @param {string} dateStr
- * @returns {boolean} - true if it's night, false otherwise
+ * @returns {boolean} true if it's night, false otherwise
  * @memberof module:Astronomy/SunCalc
  */
 function getIsNight(lat, lon, timezoneId, date, dateStr) {
@@ -147,7 +150,7 @@ function getIsNight(lat, lon, timezoneId, date, dateStr) {
 /**
  * @param {number} altitude
  * @param {string} noon
- * @returns {string} - The phase of the sun based on its altitude
+ * @returns {string} The phase of the sun based on its altitude
  * @memberof module:Astronomy/SunCalc
  */
 function getPhase(altitude, noon) {

package/src/geolocation/getGeolocation.js

@@ -4,7 +4,7 @@ import reverseGeocoding from "./lib/reversegeocoding.js";
 /**
  * Get the current geolocation of the device and reverse geocode it to get the address.
  *
- * @returns {Promise<{latitude: number, longitude: number, formatted_address: string}>}
+ * @returns {Promise<{latitude: number, longitude: number, formatted_address: string}>} Promise
  * @throws {Error} If geolocation is not supported or permission is denied.
  * @memberof module:Geolocation
  */

package/src/geolocation/timeFromLocation.js

@@ -1,15 +1,27 @@
 // @ts-nocheck
 import TimeDateStr from "../utils/timehelpers.js";
 
+/**
+ * @memberof module:Geolocation
+ * @typedef {Object} LocalTimeData
+ * @property {Date} time - The local time.
+ * @property {string} timeStr - The formatted local time string.
+ * @property {string} timezone - The timezone name.
+ * @property {string} timezoneId - The timezone ID.
+ * @property {number} offset - The UTC offset in hours.
+ * @property {string} offsetSign - The sign of the offset ('+' or '-').
+ * @property {number} dstOffset - The DST offset in hours.
+ */
+
 //------------------------------------------------------
 /**
  * Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
  *
- * @param {string} apiKey - GoogleMaps API key.
+ * @param {string} apiKey GoogleMaps API key.
  * @param {number} lat
  * @param {number} lng
- * @returns {Promise<any | LocalTimeData>} - An object containing the local time and timezone information:
- * @throws {Error} - If the API request fails or returns an error status.
+ * @returns {Promise<any | LocalTimeData>} An object containing the local time and timezone information:
+ * @throws {Error} If the API request fails or returns an error status.
  * @memberof module:Geolocation
  */
 export async function timeFromLocation(apiKey, lat, lng) {

package/src/utils/degreesToCompass.js

@@ -52,7 +52,7 @@ const directionsEs = [
  *
  * @param {number} degrees
  * @param {string} language - Language code ("en-US", "es-ES", "auto")
- * @returns {{short: string, full: string}}
+ * @returns {{short: string, full: string}} {short: string, full: string}
  * @memberof module:Utils
  */
 export function degreesToCompass(degrees, language = "auto") {

package/src/utils/timehelpers.js

@@ -63,7 +63,7 @@ function timeString(date = new Date(), sec = false) {
  * Returns a now time as a formated string.
  *
  * @param {boolean} sec
- * @returns {String}
+ * @returns {String} now time as a formated string
  * @memberof module:Utils/TimeDateStr
  */
 function nowString(sec = false) {

package/src/utils/warning.js

@@ -27,6 +27,7 @@ const ALERT_LEVEL = [
  * @param {number} showersSumToday
  * @param {number} showersSumTomorrow
  * @returns {{ levelNum: number, level: string, message: string, day: number } | null}
+ * {{ levelNum: number, level: string, message: string, day: number } | null}
  * @memberof module:Utils
  */
 export function getWarningByDays(
@@ -63,6 +64,7 @@ export function getWarningByDays(
  * @param {number} precipitation
  * @param {number} showers
  * @returns {{ levelNum: number, level: string, message: string } | null}
+ * {{ levelNum: number, level: string, message: string } | null}
  * @memberof module:Utils
  */
 export function getWarning(precipitation, showers) {

package/src/utils/wind/windArrowTx.js

@@ -1,11 +1,8 @@
-/**
- * Convert wind direction in degrees to an arrow representation.
- */
-
 /**
  * Convert wind direction in degrees to an arrow representation.
  *
  * @param {number} deg - Wind direction in degrees.
+ * @returns {string} Arrow representation of the wind direction.
  * @memberof module:Utils
  */
 export function windArrowTx(deg) {
@@ -22,4 +19,5 @@ export function windArrowTx(deg) {
   if (deg < 247.5) return "↗";
   if (deg < 292.5) return "→";
   if (deg < 337.5) return "↘";
+  return "↓"; // Default arrow for degrees >= 337.5
 }

package/src/utils/wind/windLevel.js

@@ -1,7 +1,3 @@
-/**
- * Ordered list of wind levels.
- */
-
 /**
  * @typedef {Object} WindLevel
  * @property {number} id - Level ID

package/src/astronomy/types.js

@@ -1,20 +0,0 @@
-/**
- * @memberof module:Astronomy
- * @typedef {Object} AstroPosition
- * @property {number} altitude
- * @property {number} azimuth
- * @property {string} direction
- * @property {string} direction_full
- */
-
-/**
- * @memberof module:Astronomy
- * @typedef {Object} LocalTimeData
- * @property {Date} time - The local time.
- * @property {string} timeStr - The formatted local time string.
- * @property {string} timezone - The timezone name.
- * @property {string} timezoneId - The timezone ID.
- * @property {number} offset - The UTC offset in hours.
- * @property {string} offsetSign - The sign of the offset ('+' or '-').
- * @property {number} dstOffset - The DST offset in hours.
- */