fidelity-kit/paths
Client-safe file naming helpers, with no Node imports, shared by the CLI and the viewer.
Import from fidelity-kit/paths.
Functions
imageFile()
function imageFile(renderer, extension?): string;
File name of a renderer's image inside an output folder, for example my-renderer.avif.
Parameters
| Parameter | Type | Default value |
|---|---|---|
renderer | string | undefined |
extension? | string | IMAGE_EXT |
Returns
string
isImageFile()
function isImageFile(file): boolean;
True for the supported source image extensions.
Parameters
| Parameter | Type |
|---|---|
file | string |
Returns
boolean
metricsFile()
function metricsFile(renderer, reference): string;
Name of the metrics JSON for a renderer compared against a reference.
Parameters
| Parameter | Type |
|---|---|
renderer | string |
reference | string |
Returns
string
temporalFile()
function temporalFile(renderer): string;
Sidecar of a compared renderer's dynamic (temporal) metrics, next to its representative frame.
Parameters
| Parameter | Type |
|---|---|
renderer | string |
Returns
string
deltaFile()
function deltaFile(
renderer,
reference,
extension?
): string;
Name of the delta heatmap for a renderer compared against a reference.
Parameters
| Parameter | Type | Default value |
|---|---|---|
renderer | string | undefined |
reference | string | undefined |
extension? | ".avif" | ".webp" | '.webp' |
Returns
string
isDataFile()
function isDataFile(rel): boolean;
The only suite files the viewer may read; also what build exports and hash covers.
Parameters
| Parameter | Type | Description |
|---|---|---|
rel | string | Path relative to the suite root. |
Returns
boolean
isLogoFile()
function isLogoFile(file): boolean;
Supported local branding assets, independent of renderer input formats.
Parameters
| Parameter | Type |
|---|---|
file | string |
Returns
boolean
logoUrl()
function logoUrl(path): string;
Viewer URL of a suite file such as a logo, with each path segment encoded.
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
string
Variables
IMAGE_EXT
const IMAGE_EXT: ".avif" = '.avif';
Default extension for generated result images.
IMAGE_EXTENSIONS
const IMAGE_EXTENSIONS: readonly [".avif", ".webp", ".png", ".jpg"];
Preferred source formats, in selection order.
DYNAMIC_INDEX
const DYNAMIC_INDEX: "dynamic.json" = 'dynamic.json';
Suite-level index of dynamic fidelity results.