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
| Name | Type | Required |
|---|---|---|
sourcePath | string | Yes |
compiledIds | readonly string[] | Yes |
Returns
string
load
Load the complete executable catalog for one active server locale.
load(locale: string): Promise<CompiledCatalogMessages>
Parameters
| Name | Type | Required |
|---|---|---|
locale | string | Yes |
Returns
Promise<CompiledCatalogMessages>
generation
Return the current config/catalog generation for HTTP cache keys.
generation(): string
Returns
string
sidecarUrl
sidecarUrl(key: string): string
Parameters
| Name | Type | Required |
|---|---|---|
key | string | Yes |
Returns
string
serve
serve(request: Request): Response | undefined
Parameters
| Name | Type | Required |
|---|---|---|
request | Request | Yes |
Returns
Response | undefined
invalidate
invalidate(sourcePath?: string): void
Parameters
| Name | Type | Required |
|---|---|---|
sourcePath | string | No |
Returns
void
close
Close development file watchers when the host shuts down.
close(): void
Returns
void
Last updated: November 1, 2026