Skip to content

Lupa API Reference / network/types / SerializedMatch

Interface: SerializedMatch ​

Defined in: src/network/types.ts:113

Represents a serialized route matcher sent from the browser/client.

Properties ​

headers? ​

optional headers?: Record<string, string>

Defined in: src/network/types.ts:147

HTTP headers required for a successful match.


methods? ​

optional methods?: string[]

Defined in: src/network/types.ts:142

HTTP methods to match (e.g., ['GET', 'POST']).


pathname? ​

optional pathname?: string

Defined in: src/network/types.ts:127

Explicit pathname pattern.


query? ​

optional query?: Record<string, string | string[]>

Defined in: src/network/types.ts:137

Declarative query parameter key-value pairs to match against parsed URL parameters.


optional search?: string

Defined in: src/network/types.ts:132

Explicit search query pattern (e.g., '*' or 'sort=:sort').


type ​

type: "string" | "options"

Defined in: src/network/types.ts:117

Type of the matcher definition.


uri? ​

optional uri?: string

Defined in: src/network/types.ts:122

The URI or URL pattern to match against.