@angelrove/forecast-utils 1.1.5 → 1.1.6

package/README.md

@@ -14,14 +14,15 @@
 ¡Solo proporcionar HORA LOCAL DEL SISTEMA!: 'new Date()'
 Con excepción de &#39;getSolarTime()&#39;: recibe la hora local correspondiente a la localización dada.</p>
 </dd>
-<dt><a href="#module_Astronomy/helpers">Astronomy/helpers</a></dt>
-<dd></dd>
 <dt><a href="#module_Geolocation">Geolocation</a></dt>
 <dd></dd>
 <dt><a href="#module_OpenMeteo">OpenMeteo</a></dt>
 <dd></dd>
 <dt><a href="#module_Utils">Utils</a></dt>
 <dd></dd>
+<dt><a href="#module_Utils/TimeDateStr">Utils/TimeDateStr</a></dt>
+<dd><p>Helpers for get date and time formeted strings</p>
+</dd>
 </dl>
 
 <a name="module_Astronomy/MoonCalc"></a>
@@ -263,85 +264,36 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 * * *
 
-<a name="module_Astronomy/helpers"></a>
-
-## Astronomy/helpers
-
-* [Astronomy/helpers](#module_Astronomy/helpers)
-    * [.exports.timeString([date], [sec])](#module_Astronomy/helpers.exports.timeString) ⇒ <code>string</code>
-    * [.exports.nowString(sec)](#module_Astronomy/helpers.exports.nowString) ⇒ <code>String</code>
-    * [.exports.dateFormat([date])](#module_Astronomy/helpers.exports.dateFormat) ⇒ <code>string</code>
-    * [.exports.getLocalTimeFromTz(timeZone, [date])](#module_Astronomy/helpers.exports.getLocalTimeFromTz) ⇒ <code>string</code>
-    * [.exports.getLocalTimeInfo(apiKey, lat, lng)](#module_Astronomy/helpers.exports.getLocalTimeInfo) ⇒ <code>Promise.&lt;(any\|LocalTimeData)&gt;</code>
-
-
-* * *
-
-<a name="module_Astronomy/helpers.exports.timeString"></a>
-
-### Astronomy/helpers.exports.timeString([date], [sec]) ⇒ <code>string</code>
-Formatea una fecha a un string legible.
-
-**Kind**: static method of [<code>Astronomy/helpers</code>](#module_Astronomy/helpers)  
-**Returns**: <code>string</code> - La fecha formateada.  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [date] | <code>Date</code> |  | 
-| [sec] | <code>boolean</code> | <code>false</code> | 
-
-
-* * *
-
-<a name="module_Astronomy/helpers.exports.nowString"></a>
-
-### Astronomy/helpers.exports.nowString(sec) ⇒ <code>String</code>
-**Kind**: static method of [<code>Astronomy/helpers</code>](#module_Astronomy/helpers)  
-
-| Param | Type |
-| --- | --- |
-| sec | <code>boolean</code> | 
-
-
-* * *
-
-<a name="module_Astronomy/helpers.exports.dateFormat"></a>
-
-### Astronomy/helpers.exports.dateFormat([date]) ⇒ <code>string</code>
-Formatea una fecha a un string legible.
+<a name="module_Geolocation"></a>
 
-**Kind**: static method of [<code>Astronomy/helpers</code>](#module_Astronomy/helpers)  
-**Returns**: <code>string</code> - La fecha formateada.  
+## Geolocation
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [date] | <code>Date</code> | <code>new Date()</code> | La fecha a formatear. |
+* [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>
 
 
 * * *
 
-<a name="module_Astronomy/helpers.exports.getLocalTimeFromTz"></a>
+<a name="module_Geolocation.exports.getGeolocation"></a>
 
-### Astronomy/helpers.exports.getLocalTimeFromTz(timeZone, [date]) ⇒ <code>string</code>
-Get local time from timezone
+### Geolocation.exports.getGeolocation() ⇒ <code>Promise.&lt;{latitude: number, longitude: number, formatted\_address: string}&gt;</code>
+Get the current geolocation of the device and reverse geocode it to get the address.
 
-**Kind**: static method of [<code>Astronomy/helpers</code>](#module_Astronomy/helpers)  
-**Returns**: <code>string</code> - - The formatted local time string.  
+**Kind**: static method of [<code>Geolocation</code>](#module_Geolocation)  
+**Throws**:
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| timeZone | <code>string</code> |  | The timezone string (e.g., 'America/New_York'). |
-| [date] | <code>Date</code> \| <code>number</code> | <code>new Date()</code> | The date object to format. Defaults to the current date. |
+- <code>Error</code> If geolocation is not supported or permission is denied.
 
 
 * * *
 
-<a name="module_Astronomy/helpers.exports.getLocalTimeInfo"></a>
+<a name="module_Geolocation.exports.timeFromLocation"></a>
 
-### Astronomy/helpers.exports.getLocalTimeInfo(apiKey, lat, lng) ⇒ <code>Promise.&lt;(any\|LocalTimeData)&gt;</code>
-Get local time from any location using Google Maps TimeZone API.
+### Geolocation.exports.timeFromLocation(apiKey, lat, lng) ⇒ <code>Promise.&lt;(any\|LocalTimeData)&gt;</code>
+Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
 
-**Kind**: static method of [<code>Astronomy/helpers</code>](#module_Astronomy/helpers)  
+**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:  
 **Throws**:
 
@@ -355,25 +307,6 @@ Get local time from any location using Google Maps TimeZone API.
 | lng | <code>number</code> |  |
 
 
-* * *
-
-<a name="module_Geolocation"></a>
-
-## Geolocation
-
-* * *
-
-<a name="module_Geolocation.exports.getGeolocation"></a>
-
-### Geolocation.exports.getGeolocation() ⇒ <code>Promise.&lt;{latitude: number, longitude: number, formatted\_address: string}&gt;</code>
-Get the current geolocation of the device and reverse geocode it to get the address.
-
-**Kind**: static method of [<code>Geolocation</code>](#module_Geolocation)  
-**Throws**:
-
-- <code>Error</code> If geolocation is not supported or permission is denied.
-
-
 * * *
 
 <a name="module_OpenMeteo"></a>
@@ -466,6 +399,7 @@ Get weather symbol and description based on the weather code.
     * [.exports.degreesToCompass(degrees, language)](#module_Utils.exports.degreesToCompass) ⇒ <code>Object</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.getWindLevel(speed)](#module_Utils.exports.getWindLevel) ⇒ <code>WindLevel</code> \| <code>null</code>
     * [.Compass](#module_Utils.Compass) : <code>Object</code>
@@ -570,6 +504,30 @@ Get warning by precipitation and showers
 | showers | <code>number</code> | 
 
 
+* * *
+
+<a name="module_Utils.exports.WindArrow"></a>
+
+### Utils.exports.WindArrow(props)
+SVG arrow indicating wind direction.
+
+**Kind**: static method of [<code>Utils</code>](#module_Utils)  
+**Component**: JSX  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | <code>Object</code> | Component props. |
+
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| props.deg | <code>number</code> | Wind direction in degrees (0 = North, 90 = East, etc.). |
+| [props.size] | <code>string</code> | Tailwind CSS size class (e.g., 'size-10') |
+| [props.strokeWidth] | <code>number</code> | Stroke width of the arrow (range: 1–6). |
+| [props.className] | <code>string</code> | Additional CSS classes. |
+
+
 * * *
 
 <a name="module_Utils.exports.windArrowTx"></a>
@@ -648,3 +606,79 @@ Return the wind level based on the speed.
 
 * * *
 
+<a name="module_Utils/TimeDateStr"></a>
+
+## Utils/TimeDateStr
+Helpers for get date and time formeted strings
+
+
+* [Utils/TimeDateStr](#module_Utils/TimeDateStr)
+    * [.dateFormat([date])](#module_Utils/TimeDateStr.dateFormat) ⇒ <code>string</code>
+    * [.timeString([date], [sec])](#module_Utils/TimeDateStr.timeString) ⇒ <code>string</code>
+    * [.nowString(sec)](#module_Utils/TimeDateStr.nowString) ⇒ <code>String</code>
+    * [.getLocalTimeFromTz(timeZone, [date])](#module_Utils/TimeDateStr.getLocalTimeFromTz) ⇒ <code>string</code>
+
+
+* * *
+
+<a name="module_Utils/TimeDateStr.dateFormat"></a>
+
+### Utils/TimeDateStr.dateFormat([date]) ⇒ <code>string</code>
+Returns a date as a formated string.
+
+**Kind**: static method of [<code>Utils/TimeDateStr</code>](#module_Utils/TimeDateStr)  
+**Returns**: <code>string</code> - La fecha formateada.  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [date] | <code>Date</code> | <code>new Date()</code> | La fecha a formatear. |
+
+
+* * *
+
+<a name="module_Utils/TimeDateStr.timeString"></a>
+
+### Utils/TimeDateStr.timeString([date], [sec]) ⇒ <code>string</code>
+Returns a time as a formated string.
+
+**Kind**: static method of [<code>Utils/TimeDateStr</code>](#module_Utils/TimeDateStr)  
+**Returns**: <code>string</code> - La fecha formateada.  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| [date] | <code>Date</code> |  | 
+| [sec] | <code>boolean</code> | <code>false</code> | 
+
+
+* * *
+
+<a name="module_Utils/TimeDateStr.nowString"></a>
+
+### Utils/TimeDateStr.nowString(sec) ⇒ <code>String</code>
+Returns a now time as a formated string.
+
+**Kind**: static method of [<code>Utils/TimeDateStr</code>](#module_Utils/TimeDateStr)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| sec | <code>boolean</code> | <code>false</code> | 
+
+
+* * *
+
+<a name="module_Utils/TimeDateStr.getLocalTimeFromTz"></a>
+
+### Utils/TimeDateStr.getLocalTimeFromTz(timeZone, [date]) ⇒ <code>string</code>
+Return the local time string from a given timezone.
+
+**Kind**: static method of [<code>Utils/TimeDateStr</code>](#module_Utils/TimeDateStr)  
+**Returns**: <code>string</code> - - The formatted local time string.  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| timeZone | <code>string</code> |  | The timezone string (e.g., 'America/New_York'). |
+| [date] | <code>Date</code> \| <code>number</code> | <code>new Date()</code> | The date object to format. Defaults to the current date. |
+
+
+* * *
+

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

@@ -10,7 +10,7 @@ declare namespace TimeDateStr {
  *
  * @param {Date} [date=new Date()] La fecha a formatear.
  * @returns {string} La fecha formateada.
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 declare function dateFormat(date?: Date | undefined): string;
 /**
@@ -18,7 +18,7 @@ declare function dateFormat(date?: Date | undefined): string;
  *
  * @param {boolean} sec
  * @returns {String}
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 declare function nowString(sec?: boolean): string;
 /**
@@ -27,7 +27,7 @@ declare function nowString(sec?: boolean): string;
  * @param {Date} [date]
  * @param {boolean} [sec=false]
  * @returns {string} La fecha formateada.
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 declare function timeString(date?: Date | undefined, sec?: boolean | undefined): string;
 /**
@@ -36,6 +36,6 @@ declare function timeString(date?: Date | undefined, sec?: boolean | undefined):
  * @param {string} timeZone - The timezone string (e.g., 'America/New_York').
  * @param {Date | number} [date=new Date()] - The date object to format. Defaults to the current date.
  * @returns {string} - The formatted local time string.
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 declare function getLocalTimeFromTz(timeZone: string, date?: number | Date | undefined): string;

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

@@ -2,32 +2,14 @@
  * Wind direction arrow component (svg image).
  */
 /**
- * @typedef {Object} WindArrowProps
- * @property {number} props.deg - Wind direction in degrees
- * @property {string} [props.size] - Size of the arrow (Tailwind CSS size: 'size-10')
- * @property {number} [props.strokeWidth] - Stroke width of the arrow (1 to 6)
- * @property {string} [props.className]
- */
-/**
- * Wind direction arrow component (svg image).
+ * SVG arrow indicating wind direction.
  *
- * @component
- * @param {WindArrowProps} props
+ * @component JSX
+ * @param {Object} props - Component props.
+ * @prop {number} props.deg - Wind direction in degrees (0 = North, 90 = East, etc.).
+ * @prop {string} [props.size] - Tailwind CSS size class (e.g., 'size-10')
+ * @prop {number} [props.strokeWidth] - Stroke width of the arrow (range: 1–6).
+ * @prop {string} [props.className] - Additional CSS classes.
  * @memberof module:Utils
  */
-export function WindArrow({ deg, size, strokeWidth, className, }: WindArrowProps): any;
-export type WindArrowProps = {
-    /**
-     * - Wind direction in degrees
-     */
-    deg: number;
-    /**
-     * - Size of the arrow (Tailwind CSS size: 'size-10')
-     */
-    size?: string;
-    /**
-     * - Stroke width of the arrow (1 to 6)
-     */
-    strokeWidth?: number;
-    className?: string;
-};
+export function WindArrow({ deg, size, strokeWidth, className, }: Object): any;

package/package.json

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

package/src/utils/timehelpers.js

@@ -1,6 +1,7 @@
 /**
  * Helpers for get date and time formeted strings
  *
+ * @module Utils/TimeDateStr
  */
 
 /**
@@ -21,7 +22,7 @@ export default TimeDateStr;
  *
  * @param {Date} [date=new Date()] La fecha a formatear.
  * @returns {string} La fecha formateada.
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 function dateFormat(date = new Date()) {
   const options = {
@@ -39,7 +40,7 @@ function dateFormat(date = new Date()) {
  * @param {Date} [date]
  * @param {boolean} [sec=false]
  * @returns {string} La fecha formateada.
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 function timeString(date = new Date(), sec = false) {
   if (sec) {
@@ -63,7 +64,7 @@ function timeString(date = new Date(), sec = false) {
  *
  * @param {boolean} sec
  * @returns {String}
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 function nowString(sec = false) {
   return timeString(new Date(), sec);
@@ -75,7 +76,7 @@ function nowString(sec = false) {
  * @param {string} timeZone - The timezone string (e.g., 'America/New_York').
  * @param {Date | number} [date=new Date()] - The date object to format. Defaults to the current date.
  * @returns {string} - The formatted local time string.
- * @memberof module:Utils
+ * @memberof module:Utils/TimeDateStr
  */
 function getLocalTimeFromTz(timeZone, date = new Date()) {
   // Timezone example

package/src/utils/wind/WindArrow.jsx

@@ -1,20 +1,26 @@
+// @ts-nocheck
 /**
  * Wind direction arrow component (svg image).
  */
 
-/**
- * @typedef {Object} WindArrowProps
- * @property {number} props.deg - Wind direction in degrees
- * @property {string} [props.size] - Size of the arrow (Tailwind CSS size: 'size-10')
- * @property {number} [props.strokeWidth] - Stroke width of the arrow (1 to 6)
- * @property {string} [props.className]
- */
+// /**
+//  * @typedef {Object} WindArrowProps
+//  * @property {number} props.deg - Wind direction in degrees
+//  * @property {string} [props.size] - Size of the arrow (Tailwind CSS size: 'size-10')
+//  * @property {number} [props.strokeWidth] - Stroke width of the arrow (1 to 6)
+//  * @property {string} [props.className]
+//  * @memberof module:Utils
+//  */
 
 /**
- * Wind direction arrow component (svg image).
+ * SVG arrow indicating wind direction.
  *
- * @component
- * @param {WindArrowProps} props
+ * @component JSX
+ * @param {Object} props - Component props.
+ * @prop {number} props.deg - Wind direction in degrees (0 = North, 90 = East, etc.).
+ * @prop {string} [props.size] - Tailwind CSS size class (e.g., 'size-10')
+ * @prop {number} [props.strokeWidth] - Stroke width of the arrow (range: 1–6).
+ * @prop {string} [props.className] - Additional CSS classes.
  * @memberof module:Utils
  */
 export function WindArrow({