effx
API reference@effx/compiler

route-params

API reference for @effx/compiler/route-params

route-params.ts overview

HttpApiBuilder passes paths through HttpApiPath.toRouterPath before FindMyWay registers them. A declared name ends before a literal colon (including an action suffix); undeclared colons become escaped literals, not parameters. See effect/src/http-api/internal/path.ts:20-61 and effect/src/http/FindMyWay/internal/router.ts:128-235 (Effect 4.0.0).

Shared by the Http.Contract validation and the request-channel derivation (spec 0024 §2), which must agree on what a route parameter is.


Exports Grouped by Category


utils

routeParamNames

HttpApiBuilder passes paths through HttpApiPath.toRouterPath before FindMyWay registers them. A declared name ends before a literal colon (including an action suffix); undeclared colons become escaped literals, not parameters. See effect/src/http-api/internal/path.ts:20-61 and effect/src/http/FindMyWay/internal/router.ts:128-235 (Effect 4.0.0).

Shared by the Http.Contract validation and the request-channel derivation (spec 0024 §2), which must agree on what a route parameter is.

Signature

declare const routeParamNames: (path: string, declared?: ReadonlySet<string>) => Array<string>

On this page