Skip to content

[express-serve-static-core] optional parameters and ./- delimited parameters #53513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 14 commits into from
Jun 28, 2021
Merged

[express-serve-static-core] optional parameters and ./- delimited parameters #53513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d557c0f
specify minimum ts version for template literal types
DetachHead Feb 16, 2021
f718e32
set minimum ts version for absolute-url to 4.1 since it depends on ex…
DetachHead Feb 16, 2021
aa227a0
set minimum typescript version for express-serve-static-core to 4.1
DetachHead Feb 16, 2021
d872196
revert changes to minimum ts version, gonna make a seperate <=4.0 pac…
DetachHead Feb 16, 2021
8efd720
support optional params and params separated by dashes and dots
DetachHead May 31, 2021
8f37ae7
oops tests in the wrong spot
DetachHead May 31, 2021
07f95d9
fallback to ParamsDictionary when regex is detected in route params
DetachHead May 31, 2021
607484d
use ParamsDictionary when string extends Route
DetachHead May 31, 2021
510f8dc
more descriptive generic names
DetachHead May 31, 2021
6de7a5c
strict-export-declare-modifiers lint error
DetachHead May 31, 2021
38bd093
prettier fix
DetachHead May 31, 2021
5c11948
improve formatting for RouteParameters type
DetachHead Jun 11, 2021
e9bc2f0
prettier-ignore RouteParameters type
DetachHead Jun 11, 2021
b9a464f
change never in RouteParameters condition to unknown
DetachHead Jun 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion types/express-serve-static-core/express-serve-static-core-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,29 @@ app.route('/:foo/:bar').get<{ foo: string; bar: number }>(req => {
req.params.baz; // $ExpectError
});

// Optional params
app.get('/:foo/:bar?', req => {
req.params.foo; // $ExpectType string
req.params.bar; // $ExpectType string | undefined
});

// Different delimiters
app.get('/:foo/:bar-:baz/:qux', req => {
req.params.foo; // $ExpectType string
req.params.bar; // $ExpectType string
req.params.baz; // $ExpectType string
req.params.qux; // $ExpectType string
req.params.quxx; // $ExpectError
});

// regex parameters - not supported
app.get('/:foo/:bar(\\d:+)/:baz', req => {
req.params.foo; // $ExpectType string
req.params.bar; // $ExpectType string
req.params.qux; // $ExpectType string
req.params.quxx; // $ExpectType string
});

// Query can be a custom type
app.get<{}, any, any, { q: string }>('/:foo', req => {
req.query.q; // $ExpectType string
Expand Down Expand Up @@ -91,7 +114,7 @@ app.get('/nextrouter', (req, res, next) => {

// Next can receive a 'route' parameter to fall back to next route
app.get('/nextroute', (req, res, next) => {
next('route'); // $ExpectType void
next('route'); // $ExpectType void
});

// Default types
Expand Down
29 changes: 19 additions & 10 deletions types/express-serve-static-core/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ import { EventEmitter } from 'events';
import { Options as RangeParserOptions, Result as RangeParserResult, Ranges as RangeParserRanges } from 'range-parser';
import { ParsedQs } from 'qs';

export {};

export type Query = ParsedQs;

export interface NextFunction {
Expand Down Expand Up @@ -96,16 +98,23 @@ export type RequestHandlerParams<
| ErrorRequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>
| Array<RequestHandler<P> | ErrorRequestHandler<P>>;

export type RouteParameterNames<Route extends string> =
string extends Route
? string
: Route extends `${string}:${infer Param}/${infer Rest}`
? (Param | RouteParameterNames<Rest>)
: (Route extends `${string}:${infer LastParam}` ? LastParam : never);

export type RouteParameters<T extends string> = {
[key in RouteParameterNames<T>]: string
};
type GetRouteParameter<RouteAfterColon extends string> = RouteAfterColon extends `${infer Char}${infer Rest}`
? Char extends '/' | '-' | '.'
? ''
: `${Char}${GetRouteParameter<Rest>}`
: RouteAfterColon;

// prettier-ignore
export type RouteParameters<Route extends string> = string extends Route
? ParamsDictionary
: Route extends `${string}(${string}`
? ParamsDictionary //TODO: handling for regex parameters
: Route extends `${string}:${infer Rest}`
? (GetRouteParameter<Rest> extends `${infer ParamName}?`
? { [P in ParamName]?: string }
: { [P in GetRouteParameter<Rest>]: string }) &
(Rest extends `${GetRouteParameter<Rest>}${infer Next}` ? RouteParameters<Next> : unknown)
: { };

export interface IRouterMatcher<
T,
Expand Down
7 changes: 0 additions & 7 deletions types/express-serve-static-core/ts4.0/express-serve-static-core-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,6 @@ app.route('/:foo/:bar').get<{ foo: string; bar: number }>(req => {
req.params.baz; // $ExpectError
});

// Optional params currently not supported
// TODO: support optional params - https://github.com/DefinitelyTyped/DefinitelyTyped/pull/51262#discussion_r638786417
app.get('/:foo/:bar?', req => {
req.params.foo; // $ExpectType string
req.params['bar?']; // $ExpectType string
});

// Query can be a custom type
app.get<{}, any, any, { q: string }>('/:foo', req => {
req.query.q; // $ExpectType string
Expand Down