Skip to content
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

Path can be regexp #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Path can be regexp #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ declare namespace unless {
* and methods key-pairs. If the request path or path and method match, the middleware will not run. Check
* Examples for usage.
*/
path?: string | string[];
path?: string | RegExp | (string | RegExp | { url: (string | RegExp); methods: string[]; })[];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you link to the docs/implementation that say that

  • a regexp is supported for url
  • you can mix string, regexp and objects in the array (the comment says you cant)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty obscure, but I did see https://github.com/jfromaniello/express-unless/blob/master/index.js#L51-L61 and https://github.com/jfromaniello/express-unless/blob/master/index.js#L22-L24. Seems kind of a redundant API to support methods in two places.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs don't make it clear, but from the implementation, if a path is passed that has a URL property, the same code is recursively called with the path set to that property instead. So the url member of the object can be any kind of object that could be passed unwrapped, including stupid things like { url: { url: { url: /regex/ } } }

Again, because objects are just converted, you can mix them into the array.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case I would say we should define a type alias so we can reference it recursively.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@felixfbecker I wouldn't bother to model the api exactly like that, I'd model the parts people actually need. That functionality may go away if the code is refactored, and IMHO should not be used. It's more likely to be a bug than not.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type alias / interface is still nicer than inline-interface because it can be referenced.


/**
* it could be an string or an array of strings. If the request path ends with one of these extensions the middleware will not run.
Expand Down