mirror of
https://github.com/acamarata/moon-cycle.git
synced 2026-07-01 03:04:35 +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.
63 lines
1.2 KiB
Markdown
63 lines
1.2 KiB
Markdown
[**moon-cycle v2.0.0**](../README.md)
|
|
|
|
***
|
|
|
|
[moon-cycle](../README.md) / cdnUrl
|
|
|
|
# Function: cdnUrl()
|
|
|
|
> **cdnUrl**(`filename`, `set`, `size`, `quality`, `ref?`): `string`
|
|
|
|
Defined in: [helpers.ts:36](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/helpers.ts#L36)
|
|
|
|
Returns a jsDelivr CDN URL for a specific moon image.
|
|
|
|
jsDelivr serves files directly from GitHub repositories, making it a
|
|
practical option for web applications that need the images without
|
|
bundling ~438 MB of assets locally.
|
|
|
|
## Parameters
|
|
|
|
### filename
|
|
|
|
`string`
|
|
|
|
Filename returned by `cycleMonth` or `cycleYear`, e.g. `"354.webp"`.
|
|
|
|
### set
|
|
|
|
[`ImageSet`](../type-aliases/ImageSet.md)
|
|
|
|
Image set: `'mm'` (monthly) or `'my'` (yearly).
|
|
|
|
### size
|
|
|
|
[`ImageSize`](../type-aliases/ImageSize.md)
|
|
|
|
Image dimension: `256` or `512`.
|
|
|
|
### quality
|
|
|
|
[`ImageQuality`](../type-aliases/ImageQuality.md)
|
|
|
|
WebP quality: `75` or `85`.
|
|
|
|
### ref?
|
|
|
|
`string` = `'main'`
|
|
|
|
Git ref (branch, tag, or commit SHA). Defaults to `'main'`.
|
|
|
|
## Returns
|
|
|
|
`string`
|
|
|
|
A full CDN URL string.
|
|
|
|
## Example
|
|
|
|
```ts
|
|
const file = cycleMonth();
|
|
const url = cdnUrl(file, 'mm', 256, 75);
|
|
// => 'https://cdn.jsdelivr.net/gh/acamarata/moon-cycle@main/mm-256-75/354.webp'
|
|
```
|