Options documentation may be incorrect? about path-to-regexp HOT 12 CLOSED

Haha, agreed. Let me tidy that up now

from path-to-regexp.

How does "When set to true the trailing slash will not optional" sound? It should probably be easier to phrase in reverse even.

from path-to-regexp.

"Must match exactly" sounds closer, but is kind of confusing since it only affects the trailing slash (omitted or not)

from path-to-regexp.

/route/ would still work with it's trailing slash in strict mode, correct?

(Actually, is that one optional in non-strict?)

from path-to-regexp.

Correct, you couldn't omit the trailing slash. Just as if you omitted the trailing slash, you would have to use /route to match. By default (false), it's optional. With it enabled, the slashes must match.

from path-to-regexp.

How about: "When set to false trailing slashes are optional"?

Assuming:

(Actually, is that one optional in non-strict?)

from path-to-regexp.

That's the preferred sentence, but false is the default behaviour.

from path-to-regexp.

Even better: "Trailing slashes are optional when strict is set to false."

Edit: Hmm, might not be so good as an options list item, prefer the former.

from path-to-regexp.

The only problem there is it's false by default, so I'd have to add "When false (default) trailing slashes are optional". How does that read?

from path-to-regexp.

Or "When true paths must match exactly with trailing slashes"?

from path-to-regexp.

Maybe I even put it back to the original "When set to true a trailing slash will affect the url matching"? I think this change may have snuck in when I was playing around with phrasing in the refactor.

from path-to-regexp.

I'm writing docs for the Router the express.js project is extracting from express and I'll probably be using this for it's options on it:

Options

• strict - While set to false trailing slashes are optional. (default: false)

Edited: /When/While/

from path-to-regexp.