solar-spa/.github/wiki/api/interfaces/SpaFormattedResult.md
Aric Camarata 3c848806ab docs: add TypeDoc API generation (typedoc@0.28.19 + typedoc-plugin-markdown@4.11.0)
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.
2026-05-30 16:41:57 -04:00

3.3 KiB

solar-spa v2.0.1


solar-spa / SpaFormattedResult

Interface: SpaFormattedResult

Defined in: types.ts:65

Extends

  • Omit<SpaResult, "sunrise" | "sunset" | "suntransit">

Properties

azimuth

azimuth: number

Defined in: types.ts:48

Topocentric azimuth angle, eastward from north (navigational convention), in degrees.

Inherited from

SpaResult.azimuth


azimuth_astro

azimuth_astro: number

Defined in: types.ts:46

Topocentric azimuth angle, westward from south (astronomical convention), in degrees.

Inherited from

SpaResult.azimuth_astro


eot

eot: number

Defined in: types.ts:60

Equation of time in minutes.

Inherited from

SpaResult.eot


error_code

error_code: number

Defined in: types.ts:62

SPA error code. Always 0 on a successful return (non-zero throws).

Inherited from

SpaResult.error_code


incidence

incidence: number

Defined in: types.ts:50

Surface incidence angle in degrees.

Inherited from

SpaResult.incidence


sun_transit_alt

sun_transit_alt: number

Defined in: types.ts:58

Sun transit altitude in degrees.

Inherited from

SpaResult.sun_transit_alt


sunrise

sunrise: string

Defined in: types.ts:67

Local sunrise time as HH:MM:SS string. "N/A" during polar day/night.


sunset

sunset: string

Defined in: types.ts:69

Local sunset time as HH:MM:SS string. "N/A" during polar day/night.


suntransit

suntransit: string

Defined in: types.ts:71

Local sun transit time as HH:MM:SS string. "N/A" during polar day/night.


zenith

zenith: number

Defined in: types.ts:44

Topocentric zenith angle in degrees.

Inherited from

SpaResult.zenith