Skip to content

Remix: PalamedesRemixCatalogAssetRegistry

Functions, types, and exports for Remix: PalamedesRemixCatalogAssetRegistry.

Page outline
import type { PalamedesRemixCatalogAssetRegistry } from "@palamedes/remix"

type PalamedesRemixCatalogAssetRegistry = {
    /** Register the IDs present in an authored source module, unchanged by custom loaders. */
    register(sourcePath: string, compiledIds: readonly string[]): string;
    /** Load the complete executable catalog for one active server locale. */
    load?(locale: string): Promise<CompiledCatalogMessages>;
    /** Return the current config/catalog generation for HTTP cache keys. */
    generation?(): string;
    sidecarUrl(key: string): string;
    serve(request: Request): Response | undefined;
    invalidate(sourcePath?: string): void;
    /** Close development file watchers when the host shuts down. */
    close?(): void;
};

register

Register the IDs present in an authored source module, unchanged by custom loaders.

register(sourcePath: string, compiledIds: readonly string[]): string

Parameters

NameTypeRequired
sourcePathstringYes
compiledIdsreadonly string[]Yes

Returns

string

load

Load the complete executable catalog for one active server locale.

load(locale: string): Promise<CompiledCatalogMessages>

Parameters

NameTypeRequired
localestringYes

Returns

Promise<CompiledCatalogMessages>

generation

Return the current config/catalog generation for HTTP cache keys.

generation(): string

Returns

string

sidecarUrl

sidecarUrl(key: string): string

Parameters

NameTypeRequired
keystringYes

Returns

string

serve

serve(request: Request): Response | undefined

Parameters

NameTypeRequired
requestRequestYes

Returns

Response | undefined

invalidate

invalidate(sourcePath?: string): void

Parameters

NameTypeRequired
sourcePathstringNo

Returns

void

close

Close development file watchers when the host shuts down.

close(): void

Returns

void

Source entry on GitHub

Last updated: November 1, 2026