From 6be2c2011379433f803f15ffb15814d4730a51ee Mon Sep 17 00:00:00 2001 From: Aric Camarata Date: Sat, 30 May 2026 17:48:45 -0400 Subject: [PATCH] docs: refresh TypeDoc API output (T-E8-03 QA-A verify) --- .github/wiki/api/functions/calcSpa.md | 4 ++-- .github/wiki/api/functions/formatTime.md | 2 +- .github/wiki/api/functions/getSpa.md | 4 ++-- .../wiki/api/interfaces/SpaAnglesResult.md | 6 +++--- .../interfaces/SpaFormattedAnglesResult.md | 6 +++--- .../wiki/api/interfaces/SpaFormattedResult.md | 12 +++++------ .../SpaFormattedResultWithAngles.md | 14 ++++++------- .github/wiki/api/interfaces/SpaOptions.md | 20 +++++++++---------- .github/wiki/api/interfaces/SpaResult.md | 12 +++++------ .../api/interfaces/SpaResultWithAngles.md | 14 ++++++------- .../wiki/api/type-aliases/SpaFunctionCode.md | 2 +- .github/wiki/api/variables/SPA_ALL.md | 2 +- .github/wiki/api/variables/SPA_ZA.md | 2 +- .github/wiki/api/variables/SPA_ZA_INC.md | 2 +- .github/wiki/api/variables/SPA_ZA_RTS.md | 2 +- 15 files changed, 52 insertions(+), 52 deletions(-) diff --git a/.github/wiki/api/functions/calcSpa.md b/.github/wiki/api/functions/calcSpa.md index 77ff140..54c0e56 100644 --- a/.github/wiki/api/functions/calcSpa.md +++ b/.github/wiki/api/functions/calcSpa.md @@ -10,7 +10,7 @@ > **calcSpa**(`date`, `latitude`, `longitude`, `timezone?`, `options?`): [`SpaFormattedResult`](../interfaces/SpaFormattedResult.md) -Defined in: [index.ts:307](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/index.ts#L307) +Defined in: [index.ts:307](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/index.ts#L307) 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. @@ -69,7 +69,7 @@ If latitude, longitude, timezone, function code, or angle values are out of rang > **calcSpa**(`date`, `latitude`, `longitude`, `timezone`, `options`, `angles`): [`SpaFormattedResultWithAngles`](../interfaces/SpaFormattedResultWithAngles.md) -Defined in: [index.ts:321](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/index.ts#L321) +Defined in: [index.ts:321](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/index.ts#L321) 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. diff --git a/.github/wiki/api/functions/formatTime.md b/.github/wiki/api/functions/formatTime.md index e29613f..4c4b888 100644 --- a/.github/wiki/api/functions/formatTime.md +++ b/.github/wiki/api/functions/formatTime.md @@ -8,7 +8,7 @@ > **formatTime**(`hours`): `string` -Defined in: [index.ts:87](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/index.ts#L87) +Defined in: [index.ts:87](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/index.ts#L87) Format fractional hours to HH:MM:SS string. Returns "N/A" for non-finite or negative values (polar night/day scenarios). diff --git a/.github/wiki/api/functions/getSpa.md b/.github/wiki/api/functions/getSpa.md index b68db9d..4aef5a8 100644 --- a/.github/wiki/api/functions/getSpa.md +++ b/.github/wiki/api/functions/getSpa.md @@ -10,7 +10,7 @@ > **getSpa**(`date`, `latitude`, `longitude`, `timezone?`, `options?`): [`SpaResult`](../interfaces/SpaResult.md) -Defined in: [index.ts:145](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/index.ts#L145) +Defined in: [index.ts:145](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/index.ts#L145) Compute solar position for the given parameters. @@ -68,7 +68,7 @@ If latitude, longitude, timezone, function code, or angle values are out of rang > **getSpa**(`date`, `latitude`, `longitude`, `timezone`, `options`, `angles`): [`SpaResultWithAngles`](../interfaces/SpaResultWithAngles.md) -Defined in: [index.ts:163](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/index.ts#L163) +Defined in: [index.ts:163](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/index.ts#L163) Compute solar position and resolve custom zenith angles (e.g., twilight). diff --git a/.github/wiki/api/interfaces/SpaAnglesResult.md b/.github/wiki/api/interfaces/SpaAnglesResult.md index 27c9567..5a183e9 100644 --- a/.github/wiki/api/interfaces/SpaAnglesResult.md +++ b/.github/wiki/api/interfaces/SpaAnglesResult.md @@ -6,7 +6,7 @@ # Interface: SpaAnglesResult -Defined in: [types.ts:78](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L78) +Defined in: [types.ts:78](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L78) ## Properties @@ -14,7 +14,7 @@ Defined in: [types.ts:78](https://github.com/acamarata/nrel-spa/blob/dea28b92623 > **sunrise**: `number` -Defined in: [types.ts:80](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L80) +Defined in: [types.ts:80](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L80) Sunrise time for this custom zenith angle. @@ -24,6 +24,6 @@ Sunrise time for this custom zenith angle. > **sunset**: `number` -Defined in: [types.ts:82](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L82) +Defined in: [types.ts:82](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L82) Sunset time for this custom zenith angle. diff --git a/.github/wiki/api/interfaces/SpaFormattedAnglesResult.md b/.github/wiki/api/interfaces/SpaFormattedAnglesResult.md index 4070b27..55c34b6 100644 --- a/.github/wiki/api/interfaces/SpaFormattedAnglesResult.md +++ b/.github/wiki/api/interfaces/SpaFormattedAnglesResult.md @@ -6,7 +6,7 @@ # Interface: SpaFormattedAnglesResult -Defined in: [types.ts:90](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L90) +Defined in: [types.ts:90](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L90) ## Properties @@ -14,7 +14,7 @@ Defined in: [types.ts:90](https://github.com/acamarata/nrel-spa/blob/dea28b92623 > **sunrise**: `string` -Defined in: [types.ts:92](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L92) +Defined in: [types.ts:92](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L92) Sunrise time for this custom zenith angle, formatted as HH:MM:SS. @@ -24,6 +24,6 @@ Sunrise time for this custom zenith angle, formatted as HH:MM:SS. > **sunset**: `string` -Defined in: [types.ts:94](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L94) +Defined in: [types.ts:94](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L94) Sunset time for this custom zenith angle, formatted as HH:MM:SS. diff --git a/.github/wiki/api/interfaces/SpaFormattedResult.md b/.github/wiki/api/interfaces/SpaFormattedResult.md index dd34d83..47d908b 100644 --- a/.github/wiki/api/interfaces/SpaFormattedResult.md +++ b/.github/wiki/api/interfaces/SpaFormattedResult.md @@ -6,7 +6,7 @@ # Interface: SpaFormattedResult -Defined in: [types.ts:65](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L65) +Defined in: [types.ts:65](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L65) ## Extended by @@ -18,7 +18,7 @@ Defined in: [types.ts:65](https://github.com/acamarata/nrel-spa/blob/dea28b92623 > **azimuth**: `number` -Defined in: [types.ts:69](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L69) +Defined in: [types.ts:69](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L69) Topocentric azimuth angle, eastward from north (navigational convention), in degrees. @@ -28,7 +28,7 @@ Topocentric azimuth angle, eastward from north (navigational convention), in deg > **solarNoon**: `string` -Defined in: [types.ts:73](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L73) +Defined in: [types.ts:73](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L73) Local sun transit time as HH:MM:SS string. "N/A" during polar day/night. @@ -38,7 +38,7 @@ Local sun transit time as HH:MM:SS string. "N/A" during polar day/night. > **sunrise**: `string` -Defined in: [types.ts:71](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L71) +Defined in: [types.ts:71](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L71) Local sunrise time as HH:MM:SS string. "N/A" during polar day/night. @@ -48,7 +48,7 @@ Local sunrise time as HH:MM:SS string. "N/A" during polar day/night. > **sunset**: `string` -Defined in: [types.ts:75](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L75) +Defined in: [types.ts:75](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L75) Local sunset time as HH:MM:SS string. "N/A" during polar day/night. @@ -58,6 +58,6 @@ Local sunset time as HH:MM:SS string. "N/A" during polar day/night. > **zenith**: `number` -Defined in: [types.ts:67](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L67) +Defined in: [types.ts:67](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L67) Topocentric zenith angle in degrees. diff --git a/.github/wiki/api/interfaces/SpaFormattedResultWithAngles.md b/.github/wiki/api/interfaces/SpaFormattedResultWithAngles.md index c35def3..d420758 100644 --- a/.github/wiki/api/interfaces/SpaFormattedResultWithAngles.md +++ b/.github/wiki/api/interfaces/SpaFormattedResultWithAngles.md @@ -6,7 +6,7 @@ # Interface: SpaFormattedResultWithAngles -Defined in: [types.ts:97](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L97) +Defined in: [types.ts:97](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L97) ## Extends @@ -18,7 +18,7 @@ Defined in: [types.ts:97](https://github.com/acamarata/nrel-spa/blob/dea28b92623 > **angles**: [`SpaFormattedAnglesResult`](SpaFormattedAnglesResult.md)[] -Defined in: [types.ts:99](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L99) +Defined in: [types.ts:99](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L99) Custom angle results with formatted times. @@ -28,7 +28,7 @@ Custom angle results with formatted times. > **azimuth**: `number` -Defined in: [types.ts:69](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L69) +Defined in: [types.ts:69](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L69) Topocentric azimuth angle, eastward from north (navigational convention), in degrees. @@ -42,7 +42,7 @@ Topocentric azimuth angle, eastward from north (navigational convention), in deg > **solarNoon**: `string` -Defined in: [types.ts:73](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L73) +Defined in: [types.ts:73](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L73) Local sun transit time as HH:MM:SS string. "N/A" during polar day/night. @@ -56,7 +56,7 @@ Local sun transit time as HH:MM:SS string. "N/A" during polar day/night. > **sunrise**: `string` -Defined in: [types.ts:71](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L71) +Defined in: [types.ts:71](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L71) Local sunrise time as HH:MM:SS string. "N/A" during polar day/night. @@ -70,7 +70,7 @@ Local sunrise time as HH:MM:SS string. "N/A" during polar day/night. > **sunset**: `string` -Defined in: [types.ts:75](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L75) +Defined in: [types.ts:75](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L75) Local sunset time as HH:MM:SS string. "N/A" during polar day/night. @@ -84,7 +84,7 @@ Local sunset time as HH:MM:SS string. "N/A" during polar day/night. > **zenith**: `number` -Defined in: [types.ts:67](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L67) +Defined in: [types.ts:67](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L67) Topocentric zenith angle in degrees. diff --git a/.github/wiki/api/interfaces/SpaOptions.md b/.github/wiki/api/interfaces/SpaOptions.md index f77efe6..5ffa8a5 100644 --- a/.github/wiki/api/interfaces/SpaOptions.md +++ b/.github/wiki/api/interfaces/SpaOptions.md @@ -6,7 +6,7 @@ # Interface: SpaOptions -Defined in: [types.ts:31](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L31) +Defined in: [types.ts:31](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L31) ## Properties @@ -14,7 +14,7 @@ Defined in: [types.ts:31](https://github.com/acamarata/nrel-spa/blob/dea28b92623 > `optional` **atmos\_refract?**: `number` -Defined in: [types.ts:47](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L47) +Defined in: [types.ts:47](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L47) Atmospheric refraction at sunrise/sunset in degrees. Default: 0.5667. @@ -24,7 +24,7 @@ Atmospheric refraction at sunrise/sunset in degrees. Default: 0.5667. > `optional` **azm\_rotation?**: `number` -Defined in: [types.ts:45](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L45) +Defined in: [types.ts:45](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L45) Surface azimuth rotation in degrees from south. Default: 0. @@ -34,7 +34,7 @@ Surface azimuth rotation in degrees from south. Default: 0. > `optional` **delta\_t?**: `number` -Defined in: [types.ts:41](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L41) +Defined in: [types.ts:41](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L41) TT-UTC difference in seconds. Default: 67. @@ -44,7 +44,7 @@ TT-UTC difference in seconds. Default: 67. > `optional` **delta\_ut1?**: `number` -Defined in: [types.ts:39](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L39) +Defined in: [types.ts:39](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L39) UT1-UTC correction in seconds. Default: 0. @@ -54,7 +54,7 @@ UT1-UTC correction in seconds. Default: 0. > `optional` **elevation?**: `number` -Defined in: [types.ts:33](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L33) +Defined in: [types.ts:33](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L33) Observer elevation in meters above sea level. Default: 0. @@ -64,7 +64,7 @@ Observer elevation in meters above sea level. Default: 0. > `optional` **function?**: [`SpaFunctionCode`](../type-aliases/SpaFunctionCode.md) -Defined in: [types.ts:49](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L49) +Defined in: [types.ts:49](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L49) SPA function code. Default: SPA_ZA_RTS (2). @@ -74,7 +74,7 @@ SPA function code. Default: SPA_ZA_RTS (2). > `optional` **pressure?**: `number` -Defined in: [types.ts:35](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L35) +Defined in: [types.ts:35](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L35) Atmospheric pressure in millibars. Default: 1013. @@ -84,7 +84,7 @@ Atmospheric pressure in millibars. Default: 1013. > `optional` **slope?**: `number` -Defined in: [types.ts:43](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L43) +Defined in: [types.ts:43](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L43) Surface slope in degrees from horizontal. Default: 0. @@ -94,6 +94,6 @@ Surface slope in degrees from horizontal. Default: 0. > `optional` **temperature?**: `number` -Defined in: [types.ts:37](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L37) +Defined in: [types.ts:37](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L37) Temperature in degrees Celsius. Default: 15. diff --git a/.github/wiki/api/interfaces/SpaResult.md b/.github/wiki/api/interfaces/SpaResult.md index a95cff9..8421033 100644 --- a/.github/wiki/api/interfaces/SpaResult.md +++ b/.github/wiki/api/interfaces/SpaResult.md @@ -6,7 +6,7 @@ # Interface: SpaResult -Defined in: [types.ts:52](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L52) +Defined in: [types.ts:52](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L52) ## Extended by @@ -18,7 +18,7 @@ Defined in: [types.ts:52](https://github.com/acamarata/nrel-spa/blob/dea28b92623 > **azimuth**: `number` -Defined in: [types.ts:56](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L56) Topocentric azimuth angle, eastward from north (navigational convention), in degrees. @@ -28,7 +28,7 @@ Topocentric azimuth angle, eastward from north (navigational convention), in deg > **solarNoon**: `number` -Defined in: [types.ts:60](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L60) +Defined in: [types.ts:60](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L60) Local sun transit time (solar noon) as fractional hours. @@ -38,7 +38,7 @@ Local sun transit time (solar noon) as fractional hours. > **sunrise**: `number` -Defined in: [types.ts:58](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L58) +Defined in: [types.ts:58](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L58) Local sunrise time as fractional hours. @@ -48,7 +48,7 @@ Local sunrise time as fractional hours. > **sunset**: `number` -Defined in: [types.ts:62](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L62) +Defined in: [types.ts:62](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L62) Local sunset time as fractional hours. @@ -58,6 +58,6 @@ Local sunset time as fractional hours. > **zenith**: `number` -Defined in: [types.ts:54](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L54) +Defined in: [types.ts:54](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L54) Topocentric zenith angle in degrees. diff --git a/.github/wiki/api/interfaces/SpaResultWithAngles.md b/.github/wiki/api/interfaces/SpaResultWithAngles.md index 8fe0974..2633cff 100644 --- a/.github/wiki/api/interfaces/SpaResultWithAngles.md +++ b/.github/wiki/api/interfaces/SpaResultWithAngles.md @@ -6,7 +6,7 @@ # Interface: SpaResultWithAngles -Defined in: [types.ts:85](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L85) +Defined in: [types.ts:85](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L85) ## Extends @@ -18,7 +18,7 @@ Defined in: [types.ts:85](https://github.com/acamarata/nrel-spa/blob/dea28b92623 > **angles**: [`SpaAnglesResult`](SpaAnglesResult.md)[] -Defined in: [types.ts:87](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L87) +Defined in: [types.ts:87](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L87) Custom angle results, one per angle in the input array. @@ -28,7 +28,7 @@ Custom angle results, one per angle in the input array. > **azimuth**: `number` -Defined in: [types.ts:56](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L56) Topocentric azimuth angle, eastward from north (navigational convention), in degrees. @@ -42,7 +42,7 @@ Topocentric azimuth angle, eastward from north (navigational convention), in deg > **solarNoon**: `number` -Defined in: [types.ts:60](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L60) +Defined in: [types.ts:60](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L60) Local sun transit time (solar noon) as fractional hours. @@ -56,7 +56,7 @@ Local sun transit time (solar noon) as fractional hours. > **sunrise**: `number` -Defined in: [types.ts:58](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L58) +Defined in: [types.ts:58](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L58) Local sunrise time as fractional hours. @@ -70,7 +70,7 @@ Local sunrise time as fractional hours. > **sunset**: `number` -Defined in: [types.ts:62](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L62) +Defined in: [types.ts:62](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L62) Local sunset time as fractional hours. @@ -84,7 +84,7 @@ Local sunset time as fractional hours. > **zenith**: `number` -Defined in: [types.ts:54](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L54) +Defined in: [types.ts:54](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L54) Topocentric zenith angle in degrees. diff --git a/.github/wiki/api/type-aliases/SpaFunctionCode.md b/.github/wiki/api/type-aliases/SpaFunctionCode.md index 18aba07..c34a1ec 100644 --- a/.github/wiki/api/type-aliases/SpaFunctionCode.md +++ b/.github/wiki/api/type-aliases/SpaFunctionCode.md @@ -8,4 +8,4 @@ > **SpaFunctionCode** = *typeof* [`SPA_ZA`](../variables/SPA_ZA.md) \| *typeof* [`SPA_ZA_INC`](../variables/SPA_ZA_INC.md) \| *typeof* [`SPA_ZA_RTS`](../variables/SPA_ZA_RTS.md) \| *typeof* [`SPA_ALL`](../variables/SPA_ALL.md) -Defined in: [types.ts:25](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L25) +Defined in: [types.ts:25](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L25) diff --git a/.github/wiki/api/variables/SPA_ALL.md b/.github/wiki/api/variables/SPA_ALL.md index bea0225..e7be4a6 100644 --- a/.github/wiki/api/variables/SPA_ALL.md +++ b/.github/wiki/api/variables/SPA_ALL.md @@ -8,7 +8,7 @@ > `const` **SPA\_ALL**: `3` -Defined in: [types.ts:23](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L23) +Defined in: [types.ts:23](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L23) Compute all outputs: zenith, azimuth, incidence angle, sunrise, sunset, and sun transit. Combines SPA_ZA_INC and SPA_ZA_RTS. diff --git a/.github/wiki/api/variables/SPA_ZA.md b/.github/wiki/api/variables/SPA_ZA.md index de4a034..3f8b1ef 100644 --- a/.github/wiki/api/variables/SPA_ZA.md +++ b/.github/wiki/api/variables/SPA_ZA.md @@ -8,7 +8,7 @@ > `const` **SPA\_ZA**: `0` -Defined in: [types.ts:5](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L5) +Defined in: [types.ts:5](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L5) Compute topocentric zenith and azimuth angles only. Does not compute sunrise, sunset, or solar noon. diff --git a/.github/wiki/api/variables/SPA_ZA_INC.md b/.github/wiki/api/variables/SPA_ZA_INC.md index 856a924..196a34f 100644 --- a/.github/wiki/api/variables/SPA_ZA_INC.md +++ b/.github/wiki/api/variables/SPA_ZA_INC.md @@ -8,7 +8,7 @@ > `const` **SPA\_ZA\_INC**: `1` -Defined in: [types.ts:11](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L11) +Defined in: [types.ts:11](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L11) Compute zenith, azimuth, and incidence angle for a tilted surface. Requires slope and azm_rotation in SpaOptions. diff --git a/.github/wiki/api/variables/SPA_ZA_RTS.md b/.github/wiki/api/variables/SPA_ZA_RTS.md index 1d1c737..e5a3d1f 100644 --- a/.github/wiki/api/variables/SPA_ZA_RTS.md +++ b/.github/wiki/api/variables/SPA_ZA_RTS.md @@ -8,7 +8,7 @@ > `const` **SPA\_ZA\_RTS**: `2` -Defined in: [types.ts:17](https://github.com/acamarata/nrel-spa/blob/dea28b9262311319e14e8b9f29cb072ae4aea635/src/types.ts#L17) +Defined in: [types.ts:17](https://github.com/acamarata/nrel-spa/blob/b52802f94b8c28a03228118f51c17ce21d4c14b3/src/types.ts#L17) Compute sunrise, sunset, and sun transit (solar noon) in addition to zenith and azimuth. This is the default function code.