b52802f94b
Add typedoc and typedoc-plugin-markdown as devDependencies. Add typedoc.json config targeting src/index.ts with markdown output to .github/wiki/api. Add docs script to package.json. Generate initial API reference pages. Part of T-E8-03 — TypeDoc automation for all 12 JS/TS packages.
2.4 KiB
nrel-spa / calcSpa
Function: calcSpa()
Call Signature
calcSpa(
date,latitude,longitude,timezone?,options?):SpaFormattedResult
Defined in: index.ts:307
Same as getSpa(), but formats sunrise, solarNoon, and sunset as HH:MM:SS strings. Returns "N/A" for time fields during polar day or polar night.
Parameters
date
Date
JavaScript Date object (uses UTC components)
latitude
number
Observer latitude in degrees (-90 to 90, negative = south)
longitude
number
Observer longitude in degrees (-180 to 180, negative = west)
timezone?
number | null
Hours from UTC (e.g., -4 for EDT). Default: 0
options?
SpaOptions | null
Optional atmospheric and calculation parameters
Returns
Formatted solar position result with HH:MM:SS time strings
Throws
If date, latitude, longitude, timezone, or options numeric fields are not finite numbers
Throws
If latitude, longitude, timezone, function code, or angle values are out of range
See
Call Signature
calcSpa(
date,latitude,longitude,timezone,options,angles):SpaFormattedResultWithAngles
Defined in: index.ts:321
Same as getSpa() with custom angles, but formats all time values as HH:MM:SS strings. Returns "N/A" for time fields during polar day or polar night.
Parameters
date
Date
latitude
number
longitude
number
timezone
number | null | undefined
options
SpaOptions | null | undefined
angles
`number`, `...number[]`Returns
Throws
If date, latitude, longitude, timezone, or options numeric fields are not finite numbers
Throws
If latitude, longitude, timezone, function code, or angle values are out of range