mirror of
https://github.com/acamarata/solar-spa.git
synced 2026-06-30 19:04:28 +00:00
docs: refresh TypeDoc API output (T-E8-03 QA-A verify)
This commit is contained in:
Aric Camarata
parent
3c848806ab
commit
ffb720a7c8
12 changed files with 42 additions and 42 deletions
2
.github/wiki/api/functions/formatTime.md
vendored
2
.github/wiki/api/functions/formatTime.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **formatTime**(`hours`): `string`
|
||||
|
||||
Defined in: [index.ts:113](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/index.ts#L113)
|
||||
Defined in: [index.ts:113](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/index.ts#L113)
|
||||
|
||||
Purpose: Convert fractional hours to an HH:MM:SS string.
|
||||
Inputs: hours, fractional hours (e.g. 6.5 for "06:30:00"); values ≥24 wrap
|
||||
|
|
|
|||
2
.github/wiki/api/functions/init.md
vendored
2
.github/wiki/api/functions/init.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **init**(): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [index.ts:60](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/index.ts#L60)
|
||||
Defined in: [index.ts:60](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/index.ts#L60)
|
||||
|
||||
Purpose: Pre-initialize the WASM module before the first spa() call.
|
||||
Inputs: none
|
||||
|
|
|
|||
2
.github/wiki/api/functions/spa.md
vendored
2
.github/wiki/api/functions/spa.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **spa**(`date`, `latitude`, `longitude`, `options?`): `Promise`\<[`SpaResult`](../interfaces/SpaResult.md)\>
|
||||
|
||||
Defined in: [index.ts:204](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/index.ts#L204)
|
||||
Defined in: [index.ts:204](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/index.ts#L204)
|
||||
|
||||
Purpose: Compute solar position using the NREL SPA algorithm via WASM.
|
||||
Inputs: date, latitude (-90..90), longitude (-180..180), optional SpaOptions
|
||||
|
|
|
|||
2
.github/wiki/api/functions/spaFormatted.md
vendored
2
.github/wiki/api/functions/spaFormatted.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **spaFormatted**(`date`, `latitude`, `longitude`, `options?`): `Promise`\<[`SpaFormattedResult`](../interfaces/SpaFormattedResult.md)\>
|
||||
|
||||
Defined in: [index.ts:290](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/index.ts#L290)
|
||||
Defined in: [index.ts:290](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/index.ts#L290)
|
||||
|
||||
Purpose: Compute solar position with time fields formatted as HH:MM:SS strings.
|
||||
Inputs: same as spa(): date, latitude, longitude, options
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: SpaFormattedResult
|
||||
|
||||
Defined in: [types.ts:65](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L65)
|
||||
Defined in: [types.ts:65](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L65)
|
||||
|
||||
## Extends
|
||||
|
||||
|
|
@ -18,7 +18,7 @@ Defined in: [types.ts:65](https://github.com/acamarata/solar-spa/blob/aa0161a824
|
|||
|
||||
> **azimuth**: `number`
|
||||
|
||||
Defined in: [types.ts:48](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L48)
|
||||
Defined in: [types.ts:48](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L48)
|
||||
|
||||
Topocentric azimuth angle, eastward from north (navigational convention), in degrees.
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ Topocentric azimuth angle, eastward from north (navigational convention), in deg
|
|||
|
||||
> **azimuth\_astro**: `number`
|
||||
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L46)
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L46)
|
||||
|
||||
Topocentric azimuth angle, westward from south (astronomical convention), in degrees.
|
||||
|
||||
|
|
@ -46,7 +46,7 @@ Topocentric azimuth angle, westward from south (astronomical convention), in deg
|
|||
|
||||
> **eot**: `number`
|
||||
|
||||
Defined in: [types.ts:60](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L60)
|
||||
Defined in: [types.ts:60](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L60)
|
||||
|
||||
Equation of time in minutes.
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ Equation of time in minutes.
|
|||
|
||||
> **error\_code**: `number`
|
||||
|
||||
Defined in: [types.ts:62](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L62)
|
||||
Defined in: [types.ts:62](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L62)
|
||||
|
||||
SPA error code. Always 0 on a successful return (non-zero throws).
|
||||
|
||||
|
|
@ -74,7 +74,7 @@ SPA error code. Always 0 on a successful return (non-zero throws).
|
|||
|
||||
> **incidence**: `number`
|
||||
|
||||
Defined in: [types.ts:50](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L50)
|
||||
Defined in: [types.ts:50](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L50)
|
||||
|
||||
Surface incidence angle in degrees.
|
||||
|
||||
|
|
@ -88,7 +88,7 @@ Surface incidence angle in degrees.
|
|||
|
||||
> **sun\_transit\_alt**: `number`
|
||||
|
||||
Defined in: [types.ts:58](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L58)
|
||||
Defined in: [types.ts:58](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L58)
|
||||
|
||||
Sun transit altitude in degrees.
|
||||
|
||||
|
|
@ -102,7 +102,7 @@ Sun transit altitude in degrees.
|
|||
|
||||
> **sunrise**: `string`
|
||||
|
||||
Defined in: [types.ts:67](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L67)
|
||||
Defined in: [types.ts:67](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L67)
|
||||
|
||||
Local sunrise time as HH:MM:SS string. "N/A" during polar day/night.
|
||||
|
||||
|
|
@ -112,7 +112,7 @@ Local sunrise time as HH:MM:SS string. "N/A" during polar day/night.
|
|||
|
||||
> **sunset**: `string`
|
||||
|
||||
Defined in: [types.ts:69](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L69)
|
||||
Defined in: [types.ts:69](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L69)
|
||||
|
||||
Local sunset time as HH:MM:SS string. "N/A" during polar day/night.
|
||||
|
||||
|
|
@ -122,7 +122,7 @@ Local sunset time as HH:MM:SS string. "N/A" during polar day/night.
|
|||
|
||||
> **suntransit**: `string`
|
||||
|
||||
Defined in: [types.ts:71](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L71)
|
||||
Defined in: [types.ts:71](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L71)
|
||||
|
||||
Local sun transit time as HH:MM:SS string. "N/A" during polar day/night.
|
||||
|
||||
|
|
@ -132,7 +132,7 @@ Local sun transit time as HH:MM:SS string. "N/A" during polar day/night.
|
|||
|
||||
> **zenith**: `number`
|
||||
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L44)
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L44)
|
||||
|
||||
Topocentric zenith angle in degrees.
|
||||
|
||||
|
|
|
|||
22
.github/wiki/api/interfaces/SpaOptions.md
vendored
22
.github/wiki/api/interfaces/SpaOptions.md
vendored
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: SpaOptions
|
||||
|
||||
Defined in: [types.ts:16](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L16)
|
||||
Defined in: [types.ts:16](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L16)
|
||||
|
||||
## Properties
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ Defined in: [types.ts:16](https://github.com/acamarata/solar-spa/blob/aa0161a824
|
|||
|
||||
> `optional` **atmos\_refract?**: `number`
|
||||
|
||||
Defined in: [types.ts:37](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L37)
|
||||
Defined in: [types.ts:37](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L37)
|
||||
|
||||
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:35](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L35)
|
||||
Defined in: [types.ts:35](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L35)
|
||||
|
||||
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:31](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L31)
|
||||
Defined in: [types.ts:31](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L31)
|
||||
|
||||
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:29](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L29)
|
||||
Defined in: [types.ts:29](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L29)
|
||||
|
||||
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:23](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L23)
|
||||
Defined in: [types.ts:23](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L23)
|
||||
|
||||
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:39](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L39)
|
||||
Defined in: [types.ts:39](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L39)
|
||||
|
||||
SPA function code. Default: SPA_ALL (3).
|
||||
|
||||
|
|
@ -74,7 +74,7 @@ SPA function code. Default: SPA_ALL (3).
|
|||
|
||||
> `optional` **pressure?**: `number`
|
||||
|
||||
Defined in: [types.ts:25](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L25)
|
||||
Defined in: [types.ts:25](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L25)
|
||||
|
||||
Atmospheric pressure in millibars. Default: 1013.25.
|
||||
|
||||
|
|
@ -84,7 +84,7 @@ Atmospheric pressure in millibars. Default: 1013.25.
|
|||
|
||||
> `optional` **slope?**: `number`
|
||||
|
||||
Defined in: [types.ts:33](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L33)
|
||||
Defined in: [types.ts:33](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L33)
|
||||
|
||||
Surface slope in degrees from horizontal. Default: 0.
|
||||
|
||||
|
|
@ -94,7 +94,7 @@ Surface slope in degrees from horizontal. Default: 0.
|
|||
|
||||
> `optional` **temperature?**: `number`
|
||||
|
||||
Defined in: [types.ts:27](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L27)
|
||||
Defined in: [types.ts:27](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L27)
|
||||
|
||||
Temperature in degrees Celsius. Default: 15.
|
||||
|
||||
|
|
@ -104,7 +104,7 @@ Temperature in degrees Celsius. Default: 15.
|
|||
|
||||
> `optional` **timezone?**: `number`
|
||||
|
||||
Defined in: [types.ts:21](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L21)
|
||||
Defined in: [types.ts:21](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L21)
|
||||
|
||||
Hours from UTC. If omitted, derived from the Date object's local offset.
|
||||
For historical dates or DST transitions, pass an explicit value.
|
||||
|
|
|
|||
22
.github/wiki/api/interfaces/SpaResult.md
vendored
22
.github/wiki/api/interfaces/SpaResult.md
vendored
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: SpaResult
|
||||
|
||||
Defined in: [types.ts:42](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L42)
|
||||
Defined in: [types.ts:42](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L42)
|
||||
|
||||
## Properties
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ Defined in: [types.ts:42](https://github.com/acamarata/solar-spa/blob/aa0161a824
|
|||
|
||||
> **azimuth**: `number`
|
||||
|
||||
Defined in: [types.ts:48](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L48)
|
||||
Defined in: [types.ts:48](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L48)
|
||||
|
||||
Topocentric azimuth angle, eastward from north (navigational convention), in degrees.
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ Topocentric azimuth angle, eastward from north (navigational convention), in deg
|
|||
|
||||
> **azimuth\_astro**: `number`
|
||||
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L46)
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L46)
|
||||
|
||||
Topocentric azimuth angle, westward from south (astronomical convention), in degrees.
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ Topocentric azimuth angle, westward from south (astronomical convention), in deg
|
|||
|
||||
> **eot**: `number`
|
||||
|
||||
Defined in: [types.ts:60](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L60)
|
||||
Defined in: [types.ts:60](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L60)
|
||||
|
||||
Equation of time in minutes.
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ Equation of time in minutes.
|
|||
|
||||
> **error\_code**: `number`
|
||||
|
||||
Defined in: [types.ts:62](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L62)
|
||||
Defined in: [types.ts:62](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L62)
|
||||
|
||||
SPA error code. Always 0 on a successful return (non-zero throws).
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ SPA error code. Always 0 on a successful return (non-zero throws).
|
|||
|
||||
> **incidence**: `number`
|
||||
|
||||
Defined in: [types.ts:50](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L50)
|
||||
Defined in: [types.ts:50](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L50)
|
||||
|
||||
Surface incidence angle in degrees.
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ Surface incidence angle in degrees.
|
|||
|
||||
> **sun\_transit\_alt**: `number`
|
||||
|
||||
Defined in: [types.ts:58](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L58)
|
||||
Defined in: [types.ts:58](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L58)
|
||||
|
||||
Sun transit altitude in degrees.
|
||||
|
||||
|
|
@ -74,7 +74,7 @@ Sun transit altitude in degrees.
|
|||
|
||||
> **sunrise**: `number`
|
||||
|
||||
Defined in: [types.ts:52](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L52)
|
||||
Defined in: [types.ts:52](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L52)
|
||||
|
||||
Local sunrise time as fractional hours.
|
||||
|
||||
|
|
@ -84,7 +84,7 @@ Local sunrise time as fractional hours.
|
|||
|
||||
> **sunset**: `number`
|
||||
|
||||
Defined in: [types.ts:54](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L54)
|
||||
Defined in: [types.ts:54](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L54)
|
||||
|
||||
Local sunset time as fractional hours.
|
||||
|
||||
|
|
@ -94,7 +94,7 @@ Local sunset time as fractional hours.
|
|||
|
||||
> **suntransit**: `number`
|
||||
|
||||
Defined in: [types.ts:56](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L56)
|
||||
Defined in: [types.ts:56](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L56)
|
||||
|
||||
Local sun transit time (solar noon) as fractional hours.
|
||||
|
||||
|
|
@ -104,6 +104,6 @@ Local sun transit time (solar noon) as fractional hours.
|
|||
|
||||
> **zenith**: `number`
|
||||
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L44)
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L44)
|
||||
|
||||
Topocentric zenith angle in degrees.
|
||||
|
|
|
|||
|
|
@ -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:10](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L10)
|
||||
Defined in: [types.ts:10](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L10)
|
||||
|
|
|
|||
2
.github/wiki/api/variables/SPA_ALL.md
vendored
2
.github/wiki/api/variables/SPA_ALL.md
vendored
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> `const` **SPA\_ALL**: `3`
|
||||
|
||||
Defined in: [types.ts:8](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L8)
|
||||
Defined in: [types.ts:8](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L8)
|
||||
|
||||
Compute all outputs: zenith, azimuth, incidence, and rise/transit/set.
|
||||
|
|
|
|||
2
.github/wiki/api/variables/SPA_ZA.md
vendored
2
.github/wiki/api/variables/SPA_ZA.md
vendored
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> `const` **SPA\_ZA**: `0`
|
||||
|
||||
Defined in: [types.ts:2](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L2)
|
||||
Defined in: [types.ts:2](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L2)
|
||||
|
||||
Compute zenith and azimuth only.
|
||||
|
|
|
|||
2
.github/wiki/api/variables/SPA_ZA_INC.md
vendored
2
.github/wiki/api/variables/SPA_ZA_INC.md
vendored
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> `const` **SPA\_ZA\_INC**: `1`
|
||||
|
||||
Defined in: [types.ts:4](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L4)
|
||||
Defined in: [types.ts:4](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L4)
|
||||
|
||||
Compute zenith, azimuth, and incidence angle.
|
||||
|
|
|
|||
2
.github/wiki/api/variables/SPA_ZA_RTS.md
vendored
2
.github/wiki/api/variables/SPA_ZA_RTS.md
vendored
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> `const` **SPA\_ZA\_RTS**: `2`
|
||||
|
||||
Defined in: [types.ts:6](https://github.com/acamarata/solar-spa/blob/aa0161a82431adb93846e39b5278ac65de379dec/src/types.ts#L6)
|
||||
Defined in: [types.ts:6](https://github.com/acamarata/solar-spa/blob/3c848806ab852464d76baf7e3fc0ca58f5e42fd9/src/types.ts#L6)
|
||||
|
||||
Compute zenith, azimuth, and rise/transit/set times.
|
||||
|
|
|
|||
Loading…
Reference in a new issue