mirror of
https://github.com/acamarata/moon-cycle.git
synced 2026-06-30 18:54:29 +00:00
208f7ffba1
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.
24 lines
641 B
Markdown
24 lines
641 B
Markdown
[**moon-cycle v2.0.0**](../README.md)
|
|
|
|
***
|
|
|
|
[moon-cycle](../README.md) / MONTH\_IMAGES
|
|
|
|
# Variable: MONTH\_IMAGES
|
|
|
|
> `const` **MONTH\_IMAGES**: `708` = `708`
|
|
|
|
Defined in: [types.ts:64](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/types.ts#L64)
|
|
|
|
Number of images in the monthly (`mm`) dataset.
|
|
|
|
Equals the number of hours in one synodic month, rounded to the nearest
|
|
integer. Filenames range from `"001.webp"` to `"708.webp"`.
|
|
|
|
## Example
|
|
|
|
```ts
|
|
import { MONTH_IMAGES } from 'moon-cycle';
|
|
// Fraction of the way through the synodic cycle
|
|
const index = Math.floor(fraction * MONTH_IMAGES) + 1;
|
|
```
|