typed-url-params

Types your URL parameters in compliance with Express.js router and https://github.com/pillarjs/path-to-regexp

Install

npm install typed-url-params

Usage

1type Params = ParseUrlParams<"/test"> // { }
2type Params = ParseUrlParams<"/:abc"> // { abc: string }
3type Params = ParseUrlParams<"/:abc+"> // { abc: string | string[] }
4type Params = ParseUrlParams<"/:abc*"> // { abc?: string | string[] }
5type Params = ParseUrlParams<"/users/:userId"> // { userId: string }
6type Params = ParseUrlParams<"/flights/:from-:to"> // { from: string, to: string }

Usage with Express

This library only offers typings. You must write your own wrapper for Express. You can do it like this:

1function handleGet<TypedUrl extends string>(
2  app: Express.Application,
3  url: TypedUrl,
4  handler: (req: Express.Request & { params: ParseUrlParams<TypedUrl> }, res: Express.Response, next) => void
5) {
6  // noop
7}

More examples

1
2import { ParseUrlParams } from "typed-url-params"
3
4function assert<T extends string = string>(r: ParseUrlParams<T>): asserts r is ParseUrlParams<T> {}
5
6assert<"/:asd/b">({ asd: "" })
7assert<"/xxx/:asd/bbb:dsa">({ asd: "", dsa: "" })
8assert<"/xxx/:asd/bbb/:dsa">({ asd: "", dsa: "" })
9assert<"/xxx/:asd/bbb/:dsa">({ asd: "", dsa: "" })
10assert<"/:test*-bar">({ test: [] })
11assert<"/:test*-bar">({})
12assert<"/:test*-bar">({ test: "asd" })
13assert<"/:test*-bar">({ test: ["asd"] })
14assert<"/:test+-bar">({ test: [""] })
15assert<"/:test*">({ test: [] })
16assert<"/:test+">({ test: "" })
17assert<"/:test+">({ test: [""] })
18assert<"/:test?-bar">({ test: "" })
19assert<"/:test?">({ test: "" })
20assert<"/:test(\\d+)">({ test: "" })
21assert<"/:test(\\d+)+">({ test: "" })
22assert<"/:test(\\d+)+">({ test: [""] })
23assert<"/route.:ext(json|xml)?">({})
24assert<"/route.:ext(json|xml)?">({ ext: "" })
25assert<"/route.:ext(json|xml)">({ ext: "" })
26assert<"/route.:ext(json|xml)+">({ ext: "" })
27assert<"/route.:ext(json|xml)+">({ ext: [""] })
28assert<"/route.:ext([a-z]+)*/:asd">({ ext: [""], asd: "" })
29assert<"/route.:ext([a-z]+)*/:asd">({ asd: "" })
30assert<"/route.:ext([a-z]+)*">({ ext: [""] })
31assert<"/route.:ext([a-z]+)/:asd">({ ext: "", asd: "" })
32assert<"/:test(.*)">({ test: "" })
33assert<"/route\\(\\\\(\\d+\\\\)\\)">({})
34assert<"/{apple-}?icon-:res(\\d+).png">({ res: "" })
35assert<"/:foo/:bar">({ foo: "", bar: "" })
36assert<"/users/:user_id/:asd+">({ user_id: "", asd: [] })
37assert<"/flights/:from-:to">({ from: "", to: "" })