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.
41 lines
809 B
Markdown
41 lines
809 B
Markdown
[**moon-cycle v2.0.0**](../README.md)
|
|
|
|
***
|
|
|
|
[moon-cycle](../README.md) / imageFolder
|
|
|
|
# Function: imageFolder()
|
|
|
|
> **imageFolder**(`set`, `size`, `quality`): `string`
|
|
|
|
Defined in: [helpers.ts:13](https://github.com/acamarata/moon-cycle/blob/800a74670ed6ac7b6d239efd6ec627dbb009fcea/src/helpers.ts#L13)
|
|
|
|
Returns the folder name for a given image set, size, and quality.
|
|
|
|
Folder names follow the pattern `{set}-{size}-{quality}`, matching the
|
|
directory layout in the moon-cycle repository.
|
|
|
|
## Parameters
|
|
|
|
### set
|
|
|
|
[`ImageSet`](../type-aliases/ImageSet.md)
|
|
|
|
### size
|
|
|
|
[`ImageSize`](../type-aliases/ImageSize.md)
|
|
|
|
### quality
|
|
|
|
[`ImageQuality`](../type-aliases/ImageQuality.md)
|
|
|
|
## Returns
|
|
|
|
`string`
|
|
|
|
## Example
|
|
|
|
```ts
|
|
imageFolder('mm', 256, 75) // => 'mm-256-75'
|
|
imageFolder('my', 512, 85) // => 'my-512-85'
|
|
```
|