JSPM

Modules

MoonCalc

MoonCalc for calculating moon times, positions, and phases.

• import { MoonCalc } from '@angelrov/forecast';

SunCalc

SunCalc for calculating solar times, positions, and phases.

• import { SunCalc } from '@angelrov/forecast';

astronomy/time-date

astronomy/time-date

astronomy/types

Geolocation

OpenMeteo:current

OpenMeteo:daily

OpenMeteo:hourly

OpenMeteo:weatherSymbol

utils

utils

utils

utils

MoonCalc

MoonCalc for calculating moon times, positions, and phases.

• import { MoonCalc } from '@angelrov/forecast';

• MoonCalc
  • ~phasesES : Object.<string, string>
  • ~data(latitude, longitude, [date], [language]) ⇒ MoonData
  • ~dataExt(latitude, longitude, [date], [language]) ⇒ Object
  • ~emoji(latitude, longitude, [date]) ⇒ string
  • ~times(latitude, longitude, timezoneId, date) ⇒ Object
  • ~getUpOrDown(altitude, highest) ⇒ string

MoonCalc~phasesES : Object.<string, string>

Mapa de fases lunares.

Kind: inner constant of MoonCalc

MoonCalc~data(latitude, longitude, [date], [language]) ⇒ MoonData

Kind: inner method of MoonCalc

MoonCalc~dataExt(latitude, longitude, [date], [language]) ⇒ Object

Información de la luna para una fecha y hora dadas. La fecha y hora se devolverán en la zona horaria local.

Kind: inner method of MoonCalc

MoonCalc~emoji(latitude, longitude, [date]) ⇒ string

Kind: inner method of MoonCalc
Returns: string - - Emoji of the moon phase

MoonCalc~times(latitude, longitude, timezoneId, date) ⇒ Object

Kind: inner method of MoonCalc

MoonCalc~getUpOrDown(altitude, highest) ⇒ string

Kind: inner method of MoonCalc
Returns: string - - Up or down emoji

SunCalc

SunCalc for calculating solar times, positions, and phases.

• import { SunCalc } from '@angelrov/forecast';

• SunCalc
  • ~SunCalc
  • ~all(date, latitude, longitude, timezoneId) ⇒ Object
  • ~times(date, latitude, longitude, timezoneId) ⇒ Object
  • ~getSolarTime(date, lng, offsetSign, offset) ⇒ string
  • ~position(latitude, longitude) ⇒ Object
  • ~getIsNight(lat, lon, timezoneId, date, dateStr) ⇒ boolean
  • ~getPhase(altitude, noon) ⇒ string

SunCalc~SunCalc

IMPORTANTE!!: ¡Solo proporcionar HORA LOCAL DEL SISTEMA!: 'new Date()' La única excepción es 'getSolarTime()': hay que darle la hora local correspondiente a la localización dada.

Kind: inner constant of SunCalc

SunCalc~all(date, latitude, longitude, timezoneId) ⇒ Object

Kind: inner method of SunCalc

SunCalc~times(date, latitude, longitude, timezoneId) ⇒ Object

Kind: inner method of SunCalc

SunCalc~getSolarTime(date, lng, offsetSign, offset) ⇒ string

Kind: inner method of SunCalc
Returns: string - - Local time in "HH:mm" format

SunCalc~position(latitude, longitude) ⇒ Object

Kind: inner method of SunCalc

SunCalc~getIsNight(lat, lon, timezoneId, date, dateStr) ⇒ boolean

Kind: inner method of SunCalc
Returns: boolean - - true if it's night, false otherwise

SunCalc~getPhase(altitude, noon) ⇒ string

Kind: inner method of SunCalc
Returns: string - - The phase of the sun based on its altitude

astronomy/time-date

• astronomy/time-date
  • .timeString([date], [sec]) ⇒ string
  • .dateFormat([date]) ⇒ string
  • .getLocalTimeFromTz(timeZone, [date]) ⇒ string
  • .getLocalTimeInfo(apiKey, lat, lng) ⇒ Promise.<(any|LocalTimeData)>

astronomy/time-date.timeString([date], [sec]) ⇒ string

Formatea una fecha a un string legible.

Kind: static method of astronomy/time-date
Returns: string - La fecha formateada.

astronomy/time-date.dateFormat([date]) ⇒ string

Formatea una fecha a un string legible.

Kind: static method of astronomy/time-date
Returns: string - La fecha formateada.

astronomy/time-date.getLocalTimeFromTz(timeZone, [date]) ⇒ string

Get local time from timezone

Kind: static method of astronomy/time-date
Returns: string - - The formatted local time string.

astronomy/time-date.getLocalTimeInfo(apiKey, lat, lng) ⇒ Promise.<(any|LocalTimeData)>

Google API: Get local time from any location

Kind: static method of astronomy/time-date
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.

astronomy/time-date

• astronomy/time-date
  • .timeString([date], [sec]) ⇒ string
  • .dateFormat([date]) ⇒ string
  • .getLocalTimeFromTz(timeZone, [date]) ⇒ string
  • .getLocalTimeInfo(apiKey, lat, lng) ⇒ Promise.<(any|LocalTimeData)>

astronomy/time-date.timeString([date], [sec]) ⇒ string

Formatea una fecha a un string legible.

Kind: static method of astronomy/time-date
Returns: string - La fecha formateada.

astronomy/time-date.dateFormat([date]) ⇒ string

Formatea una fecha a un string legible.

Kind: static method of astronomy/time-date
Returns: string - La fecha formateada.

astronomy/time-date.getLocalTimeFromTz(timeZone, [date]) ⇒ string

Get local time from timezone

Kind: static method of astronomy/time-date
Returns: string - - The formatted local time string.

astronomy/time-date.getLocalTimeInfo(apiKey, lat, lng) ⇒ Promise.<(any|LocalTimeData)>

Google API: Get local time from any location

Kind: static method of astronomy/time-date
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.

astronomy/types

• astronomy/types
  • ~AstroPosition : Object
  • ~MoonData : Object
  • ~LocalTimeData : Object

astronomy/types~AstroPosition : Object

Kind: inner typedef of astronomy/types
Properties

astronomy/types~MoonData : Object

Kind: inner typedef of astronomy/types
Properties

astronomy/types~LocalTimeData : Object

Kind: inner typedef of astronomy/types
Properties

Geolocation

module.exports() ⇒ Promise.<{latitude: number, longitude: number, formatted_address: string}> ⏏

Get the current geolocation of the device and reverse geocode it to get the address.

Kind: Exported function
Throws:

• Error If geolocation is not supported or permission is denied.

OpenMeteo:current

OpenMeteo:current.useForecastCurrent(lat, lon, refreshIntervalMin) ⇒ Object

Custom hook to fetch current weather data from OpenMeteo API.

Kind: static method of OpenMeteo:current

OpenMeteo:daily

OpenMeteo:daily.useForecastDaily(lat, lon, refreshIntervalMin) ⇒ Object

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 OpenMeteo:daily

OpenMeteo:hourly

OpenMeteo:hourly.useForecastHourly(location, dayNum) ⇒ Object

Custom hook to fetch hourly forecast data for a given location and number of days from OpenMeteo API.

Kind: static method of OpenMeteo:hourly

OpenMeteo:weatherSymbol

OpenMeteo:weatherSymbol.weatherSymbol(code, [precipitation], night, dark) ⇒ Object

Get weather symbol and description based on the weather code.

Kind: static method of OpenMeteo:weatherSymbol

utils

• utils
  • static
    • .degreesToCompass(degrees, language) ⇒ Object
    • .getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null
    • .getWarning(precipitation, showers) ⇒ Object | null
    • .windArrowTx(deg)
    • .getWindLevel(speed) ⇒ WindLevel | null
  • inner
    • ~ALERT_LEVEL : Array.<AlertLevel>
    • ~WIND_LEVELS : Array.<WindLevel>
    • ~getWarningRain(precipitation) ⇒ Object | null
    • ~getWarningShowers(showers) ⇒ Object | null
    • ~AlertLevel : Object
    • ~WindLevel : Object

utils.degreesToCompass(degrees, language) ⇒ Object

Convert degrees to compass designation

Kind: static method of utils

utils.getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null

Get warning by today and tomorrow

Kind: static method of utils

utils.getWarning(precipitation, showers) ⇒ Object | null

Get warning by precipitation and showers

Kind: static method of utils

utils.windArrowTx(deg)

Convert wind direction in degrees to an arrow representation.

Kind: static method of utils

utils.getWindLevel(speed) ⇒ WindLevel | null

Return the wind level based on the speed.

Kind: static method of utils
Returns: WindLevel | null - Wind level object or null if speed is null

utils~ALERT_LEVEL : Array.<AlertLevel>

Alert levels for rain and showers

Kind: inner constant of utils

utils~WIND_LEVELS : Array.<WindLevel>

Ordered list of wind levels.

Kind: inner constant of utils

utils~getWarningRain(precipitation) ⇒ Object | null

Get warning by rain

Kind: inner method of utils

utils~getWarningShowers(showers) ⇒ Object | null

Get warning by showers

Kind: inner method of utils

utils~AlertLevel : Object

Kind: inner typedef of utils
Properties

utils~WindLevel : Object

Kind: inner typedef of utils
Properties

utils

• utils
  • static
    • .degreesToCompass(degrees, language) ⇒ Object
    • .getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null
    • .getWarning(precipitation, showers) ⇒ Object | null
    • .windArrowTx(deg)
    • .getWindLevel(speed) ⇒ WindLevel | null
  • inner
    • ~ALERT_LEVEL : Array.<AlertLevel>
    • ~WIND_LEVELS : Array.<WindLevel>
    • ~getWarningRain(precipitation) ⇒ Object | null
    • ~getWarningShowers(showers) ⇒ Object | null
    • ~AlertLevel : Object
    • ~WindLevel : Object

utils.degreesToCompass(degrees, language) ⇒ Object

Convert degrees to compass designation

Kind: static method of utils

utils.getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null

Get warning by today and tomorrow

Kind: static method of utils

utils.getWarning(precipitation, showers) ⇒ Object | null

Get warning by precipitation and showers

Kind: static method of utils

utils.windArrowTx(deg)

Convert wind direction in degrees to an arrow representation.

Kind: static method of utils

utils.getWindLevel(speed) ⇒ WindLevel | null

Return the wind level based on the speed.

Kind: static method of utils
Returns: WindLevel | null - Wind level object or null if speed is null

utils~ALERT_LEVEL : Array.<AlertLevel>

Alert levels for rain and showers

Kind: inner constant of utils

utils~WIND_LEVELS : Array.<WindLevel>

Ordered list of wind levels.

Kind: inner constant of utils

utils~getWarningRain(precipitation) ⇒ Object | null

Get warning by rain

Kind: inner method of utils

utils~getWarningShowers(showers) ⇒ Object | null

Get warning by showers

Kind: inner method of utils

utils~AlertLevel : Object

Kind: inner typedef of utils
Properties

utils~WindLevel : Object

Kind: inner typedef of utils
Properties

utils

• utils
  • static
    • .degreesToCompass(degrees, language) ⇒ Object
    • .getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null
    • .getWarning(precipitation, showers) ⇒ Object | null
    • .windArrowTx(deg)
    • .getWindLevel(speed) ⇒ WindLevel | null
  • inner
    • ~ALERT_LEVEL : Array.<AlertLevel>
    • ~WIND_LEVELS : Array.<WindLevel>
    • ~getWarningRain(precipitation) ⇒ Object | null
    • ~getWarningShowers(showers) ⇒ Object | null
    • ~AlertLevel : Object
    • ~WindLevel : Object

utils.degreesToCompass(degrees, language) ⇒ Object

Convert degrees to compass designation

Kind: static method of utils

utils.getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null

Get warning by today and tomorrow

Kind: static method of utils

utils.getWarning(precipitation, showers) ⇒ Object | null

Get warning by precipitation and showers

Kind: static method of utils

utils.windArrowTx(deg)

Convert wind direction in degrees to an arrow representation.

Kind: static method of utils

utils.getWindLevel(speed) ⇒ WindLevel | null

Return the wind level based on the speed.

Kind: static method of utils
Returns: WindLevel | null - Wind level object or null if speed is null

utils~ALERT_LEVEL : Array.<AlertLevel>

Alert levels for rain and showers

Kind: inner constant of utils

utils~WIND_LEVELS : Array.<WindLevel>

Ordered list of wind levels.

Kind: inner constant of utils

utils~getWarningRain(precipitation) ⇒ Object | null

Get warning by rain

Kind: inner method of utils

utils~getWarningShowers(showers) ⇒ Object | null

Get warning by showers

Kind: inner method of utils

utils~AlertLevel : Object

Kind: inner typedef of utils
Properties

utils~WindLevel : Object

Kind: inner typedef of utils
Properties

utils

• utils
  • static
    • .degreesToCompass(degrees, language) ⇒ Object
    • .getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null
    • .getWarning(precipitation, showers) ⇒ Object | null
    • .windArrowTx(deg)
    • .getWindLevel(speed) ⇒ WindLevel | null
  • inner
    • ~ALERT_LEVEL : Array.<AlertLevel>
    • ~WIND_LEVELS : Array.<WindLevel>
    • ~getWarningRain(precipitation) ⇒ Object | null
    • ~getWarningShowers(showers) ⇒ Object | null
    • ~AlertLevel : Object
    • ~WindLevel : Object

utils.degreesToCompass(degrees, language) ⇒ Object

Convert degrees to compass designation

Kind: static method of utils

utils.getWarningByDays(precipitationSumToday, precipitationSumTomorrow, showersSumToday, showersSumTomorrow) ⇒ Object | null

Get warning by today and tomorrow

Kind: static method of utils

utils.getWarning(precipitation, showers) ⇒ Object | null

Get warning by precipitation and showers

Kind: static method of utils

utils.windArrowTx(deg)

Convert wind direction in degrees to an arrow representation.

Kind: static method of utils

utils.getWindLevel(speed) ⇒ WindLevel | null

Return the wind level based on the speed.

Kind: static method of utils
Returns: WindLevel | null - Wind level object or null if speed is null

utils~ALERT_LEVEL : Array.<AlertLevel>

Alert levels for rain and showers

Kind: inner constant of utils

utils~WIND_LEVELS : Array.<WindLevel>

Ordered list of wind levels.

Kind: inner constant of utils

utils~getWarningRain(precipitation) ⇒ Object | null

Get warning by rain

Kind: inner method of utils

utils~getWarningShowers(showers) ⇒ Object | null

Get warning by showers

Kind: inner method of utils

utils~AlertLevel : Object

Kind: inner typedef of utils
Properties

utils~WindLevel : Object

Kind: inner typedef of utils
Properties