aric/moon-cycle
1
0
Fork 0
mirror of https://github.com/acamarata/moon-cycle.git synced 2026-06-30 18:54:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: refresh TypeDoc API output (T-E8-03 QA-A verify)

Browse source
This commit is contained in:
Aric Camarata 2026-05-30 17:48:48 -04:00
parent 208f7ffba1
commit 2908ae7fa0
12 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/wiki/api/functions/cdnUrl.md vendored
View file

@ -8,7 +8,7 @@
> **cdnUrl**(`filename`, `set`, `size`, `quality`, `ref?`): `string`
Defined in: [helpers.ts:36](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/helpers.ts#L36)
Defined in: [helpers.ts:36](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/helpers.ts#L36)
Returns a jsDelivr CDN URL for a specific moon image.

2
.github/wiki/api/functions/cycleMonth.md vendored
View file

@ -8,7 +8,7 @@
> **cycleMonth**(`date?`): `string`
Defined in: [cycleMonth.ts:16](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/cycleMonth.ts#L16)
Defined in: [cycleMonth.ts:16](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/cycleMonth.ts#L16)
Maps a date to the corresponding NASA moon phase image for the monthly cycle.

2
.github/wiki/api/functions/cycleYear.md vendored
View file

@ -8,7 +8,7 @@
> **cycleYear**(`date?`): `string`
Defined in: [cycleYear.ts:17](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/cycleYear.ts#L17)
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.

2
.github/wiki/api/functions/imageFolder.md vendored
View file

@ -8,7 +8,7 @@
> **imageFolder**(`set`, `size`, `quality`): `string`
Defined in: [helpers.ts:13](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/helpers.ts#L13)
Defined in: [helpers.ts:13](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/helpers.ts#L13)
Returns the folder name for a given image set, size, and quality.

2
.github/wiki/api/type-aliases/ImageQuality.md vendored
View file

@ -8,7 +8,7 @@
> **ImageQuality** = `75` \| `85`
Defined in: [types.ts:36](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L36)
Defined in: [types.ts:36](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L36)
WebP compression quality level.

2
.github/wiki/api/type-aliases/ImageSet.md vendored
View file

@ -8,7 +8,7 @@
> **ImageSet** = `"mm"` \| `"my"`
Defined in: [types.ts:11](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L11)
Defined in: [types.ts:11](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L11)
Image set identifier.

2
.github/wiki/api/type-aliases/ImageSize.md vendored
View file

@ -8,7 +8,7 @@
> **ImageSize** = `256` \| `512`
Defined in: [types.ts:23](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L23)
Defined in: [types.ts:23](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L23)
Image dimension in pixels (square).

2
.github/wiki/api/variables/MONTH_ANCHOR.md vendored
View file

@ -8,7 +8,7 @@
> `const` **MONTH\_ANCHOR**: `Date`
Defined in: [types.ts:89](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L89)
Defined in: [types.ts:89](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L89)
Anchor date for the monthly cycle: the 2023-11-13 new moon (UTC).

2
.github/wiki/api/variables/MONTH_IMAGES.md vendored
View file

@ -8,7 +8,7 @@
> `const` **MONTH\_IMAGES**: `708` = `708`
Defined in: [types.ts:64](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L64)
Defined in: [types.ts:64](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L64)
Number of images in the monthly (`mm`) dataset.

2
.github/wiki/api/variables/SYNODIC_MONTH.md vendored
View file

@ -8,7 +8,7 @@
> `const` **SYNODIC\_MONTH**: `29.53058821398858` = `29.53058821398858`
Defined in: [types.ts:51](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L51)
Defined in: [types.ts:51](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L51)
Length of one synodic month in days.

2
.github/wiki/api/variables/YEAR_ANCHOR.md vendored
View file

@ -8,7 +8,7 @@
> `const` **YEAR\_ANCHOR**: `Date`
Defined in: [types.ts:101](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L101)
Defined in: [types.ts:101](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L101)
Anchor date for the yearly cycle: start of the 2023 NASA image collection.

2
.github/wiki/api/variables/YEAR_IMAGES.md vendored
View file

@ -8,7 +8,7 @@
> `const` **YEAR\_IMAGES**: `8760` = `8760`
Defined in: [types.ts:77](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L77)
Defined in: [types.ts:77](https://github.com/acamarata/moon-cycle/blob/208f7ffba1c1bce684a1b90ff94e52538d2632d3/src/types.ts#L77)
Number of images in the yearly (`my`) dataset.