Improve documentation #256
Conversation
Moved `pathToRegexp` function documentation to its own section, like the other functions. Added some clarification, and an example for using named parameters with `match`.
Readme.md
Outdated
| @@ -194,6 +198,21 @@ fn("/invalid"); //=> false | |||
| fn("/user/caf%C3%A9"); //=> { path: '/user/caf%C3%A9', index: 0, params: { id: 'café' } } | |||
| ``` | |||
|
|
|||
| The `match` function can be used to custom match named parameters (as of Node 10.0.0). For example, this can be used to whitelist a small number of valid paths: | |||
There was a problem hiding this comment.
I personally don't know what you mean by "(as of Node 10.0.0)" here.
I ran the example code under Node v9.11.2 and got the same output. Can you elaborate for me?
There was a problem hiding this comment.
Hmm, I must've been confusing that limitation with that of another function:
#225
Will make the change.
@jonchurch I was treating the "Parameters" section, "Named parameters" section, etc, as parts of the |
| @@ -194,6 +198,21 @@ fn("/invalid"); //=> false | |||
| fn("/user/caf%C3%A9"); //=> { path: '/user/caf%C3%A9', index: 0, params: { id: 'café' } } | |||
| ``` | |||
|
|
|||
| The `match` function can be used to custom match named parameters. For example, this can be used to whitelist a small number of valid paths: | |||
There was a problem hiding this comment.
| The `match` function can be used to custom match named parameters. For example, this can be used to whitelist a small number of valid paths: | |
| The `match` function can be used with custom match named parameters. For example, this can be used to whitelist a small number of valid paths: |
Is the goal of this section just to demonstrate you can use all the same paths as the previous documentation sections? Would it be better just to say that explicitly?
There was a problem hiding this comment.
The goal is mostly just to demonstrate how the lib could be used to name some matched parameters. With the existing docs, it took me a while to understand that :tab(about|photos) would actually provide a tab param with the matched value.
Hello, thank you for this awesome library!
In the proposed changes, I moved the
pathToRegexpfunction documentation to its own section so that it follows the structure of the other functions. I added a little clarification, and an example for using named parameters withmatch(it took me a while to understand how to use this lib for named capture groups).Hope this is helpful!