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

809 B

moon-cycle v2.0.0


moon-cycle / imageFolder

Function: imageFolder()

imageFolder(set, size, quality): string

Defined in: helpers.ts:13

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

size

ImageSize

quality

ImageQuality

Returns

string

Example

imageFolder('mm', 256, 75) // => 'mm-256-75'
imageFolder('my', 512, 85) // => 'my-512-85'