express-file-router - npm Package Compare versions

Comparing version 0.0.7 to 0.0.8

package.json

 {
   "name": "express-file-router",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "File-based router for express",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -23,4 +23,5 @@ # express-file-router
 │       ├── cars
-│       │   ├── :id*
-│       │   │   └── get.js
+│       │   ├── id
+│       │   │   ├── get.js
+│       │   │   └── route.js
 │       │   ├── get.js
@@ -94,2 +95,17 @@ │       │   └── post.js
 
+### route.js
+
+Return a route string which replaces the folder name.
+
+Note that on linux filesystems, colon and other characters are allowed. Thus you don't necessarily need a `route.js`
+file to specify a route with a parameter. However, it's still recommended to use a colon since Windows does not allow
+special characters in file names.
+
+Example: `route.js`
+```js
+module.exports = function() {
+    return ':someparam';
+}
+```
+
 ## License
@@ -96,0 +112,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10839

increased by4.55%

Number of lines in readme file

116

increased by16%

No dependency changes