moon-cycle/.github/wiki/api/functions/cycleYear.md

35 lines
899 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[**moon-cycle v2.0.0**](../README.md)
***
[moon-cycle](../README.md) / cycleYear
# Function: cycleYear()
> **cycleYear**(`date?`): `string`
Defined in: [cycleYear.ts:17](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/cycleYear.ts#L17)
Maps a date to the corresponding NASA moon image for the yearly cycle.
The yearly dataset contains 8,760 hourly images covering the full calendar
year 2023 (365 days × 24 hours). This function computes the fractional
position within a 365-day year relative to 2023-01-01 and maps that
fraction to an image index in [1, 8760].
The cycle repeats annually, so dates in any year resolve to the equivalent
hour-of-year position in the 2023 imagery.
## Parameters
### date?
`Date` = `...`
The date to resolve. Defaults to the current time.
## Returns
`string`
A zero-padded filename string, e.g. `"4380.webp"`.