express-list-endpoints - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

package.json

 {
   "name": "express-list-endpoints",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "A express package to list all registered endoints and its verbs",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # Express List Endpoints
 
 Express endpoint parser to retrieve a list of the passed router with the set verbs.
+
+## Example of use
+
+```javascript
+router.route('/')
+  .all(function(req, res) {
+    // Handle request
+  })
+  .get(function(req, res) {
+    // Handle request
+  })
+  .post(function(req, res) {
+    // Handle request
+  });
+
+router.route('/about')
+  .get(function(req, res) {
+    // Handle request
+  });
+
+console.log(listEndpoints(router.stack));
+/* It omits the 'all' verbs.
+[{
+    path: '/',
+    methods: ['GET', 'POST']
+  },
+  {
+    path: '/about',
+    methods: ['GET']
+}]
+*/
+```
+
+## license
+
+MIT

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4045

increased by30.69%

Number of package files

6

increased by20%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

40

increased by900%

No dependency changes