routup 3.0.0-alpha.3 → 3.0.0

package/README.md

@@ -61,6 +61,8 @@ as all concepts and basics are taught there.
 ### Handlers
 
 Both core and error handlers, can be defined in two different ways.
+Core handler functions can have up to 3 arguments (req, res, next) whereas error handler functions can have up to 4 arguments (err, req, res, next).
+This should be familiar to anyone who has used express before.
 
 **`Shorthand`**
 
@@ -187,17 +189,17 @@ According to the fact that routup is a minimalistic framework,
 it depends on [plugins](https://github.com/routup/plugins) to cover some 
 typically http framework functions, which are not integrated in the main package.
 
-| Name                                                                                          | Description                                                            |
-|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
-| [body](https://github.com/routup/plugins/tree/master/packages/body)                           | Read and parse the request body.                                       |
-| [cookie](https://github.com/routup/plugins/tree/master/packages/cookie)                       | Read and parse request cookies and serialize cookies for the response. |
-| [decorators](https://github.com/routup/plugins/tree/master/packages/decorators)               | Create request handlers with class-, method- & parameter-decorators.   |
-| [prometheus](https://github.com/routup/plugins/tree/master/packages/prometheus)               | Collect and serve metrics for prometheus.                              |
-| [query](https://github.com/routup/plugins/tree/master/packages/query)                         | Read and parse the query string of the request url.                    |
-| [rate-limit](https://github.com/routup/plugins/tree/master/packages/rate-limit)               | Rate limit incoming requests.                                          |
-| [rate-limit-redis](https://github.com/routup/plugins/tree/master/packages/rate-limit-redis)   | Redis adapter for the rate-limit plugin.                               |
-| [static](https://github.com/routup/plugins/tree/master/packages/static)                       | Serve static files from a directory.                                   |
-| [swagger](https://github.com/routup/plugins/tree/master/packages/swagger)                     | Serve generated docs from URL or based on a JSON file.                 |
+| Name                                                                                        | Description                                                            |
+|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
+| [assets](https://github.com/routup/plugins/tree/master/packages/assets)                     | Serve static files from a directory.                                   |
+| [body](https://github.com/routup/plugins/tree/master/packages/body)                         | Read and parse the request body.                                       |
+| [cookie](https://github.com/routup/plugins/tree/master/packages/cookie)                     | Read and parse request cookies and serialize cookies for the response. |
+| [decorators](https://github.com/routup/plugins/tree/master/packages/decorators)             | Create request handlers with class-, method- & parameter-decorators.   |
+| [prometheus](https://github.com/routup/plugins/tree/master/packages/prometheus)             | Collect and serve metrics for prometheus.                              |
+| [query](https://github.com/routup/plugins/tree/master/packages/query)                       | Read and parse the query string of the request url.                    |
+| [rate-limit](https://github.com/routup/plugins/tree/master/packages/rate-limit)             | Rate limit incoming requests.                                          |
+| [rate-limit-redis](https://github.com/routup/plugins/tree/master/packages/rate-limit-redis) | Redis adapter for the rate-limit plugin.                               |
+| [swagger](https://github.com/routup/plugins/tree/master/packages/swagger)                   | Serve generated docs from URL or based on a JSON file.                 |
 
 ## Benchmarks
 

package/dist/index.cjs

@@ -1656,10 +1656,7 @@ function isPlugin(input) {
     if (typeof input.name !== 'undefined' && typeof input.name !== 'string') {
         return false;
     }
-    if (typeof input.install !== 'function' || input.install.length !== 1) {
-        return false;
-    }
-    return typeof input.version === 'undefined' || typeof input.version === 'string';
+    return typeof input.install === 'function' && input.install.length === 1;
 }
 
 function transformRouterOptions(input) {
@@ -1781,110 +1778,50 @@ class Router {
         }
         return false;
     }
-    delete(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.DELETE,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.DELETE
-        });
+    delete(...input) {
+        this.useForMethod(exports.MethodName.DELETE, ...input);
         return this;
     }
-    get(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.GET,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.GET
-        });
+    get(...input) {
+        this.useForMethod(exports.MethodName.GET, ...input);
         return this;
     }
-    post(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.POST,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.POST
-        });
+    post(...input) {
+        this.useForMethod(exports.MethodName.POST, ...input);
         return this;
     }
-    put(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.PUT,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.PUT
-        });
+    put(...input) {
+        this.useForMethod(exports.MethodName.PUT, ...input);
         return this;
     }
-    patch(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.PATCH,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.PATCH
-        });
+    patch(...input) {
+        this.useForMethod(exports.MethodName.PATCH, ...input);
         return this;
     }
-    head(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.HEAD,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.HEAD
-        });
+    head(...input) {
+        this.useForMethod(exports.MethodName.HEAD, ...input);
+        return this;
+    }
+    options(...input) {
+        this.useForMethod(exports.MethodName.OPTIONS, ...input);
         return this;
     }
-    options(path, handler) {
-        if (isPath(path)) {
+    // --------------------------------------------------
+    useForMethod(method, ...input) {
+        const base = {
+            method
+        };
+        for(let i = 0; i < input.length; i++){
+            const element = input[i];
+            if (isPath(element)) {
+                base.path = element;
+                continue;
+            }
             this.use({
-                ...handler,
-                method: exports.MethodName.OPTIONS,
-                path
+                ...base,
+                ...element
             });
-            return this;
         }
-        this.use({
-            ...path,
-            method: exports.MethodName.OPTIONS
-        });
-        return this;
     }
     use(...input) {
         const modifyPath = (input)=>{
@@ -1910,6 +1847,7 @@ class Router {
             if (isHandler(item)) {
                 item.path = path || modifyPath(item.path);
                 this.stack.push(new Layer(item));
+                continue;
             }
             if (isPlugin(item)) {
                 if (path) {
@@ -1926,15 +1864,15 @@ class Router {
     // --------------------------------------------------
     install(plugin, context = {}) {
         const name = context.name || plugin.name;
+        const router = new Router({
+            name
+        });
+        plugin.install(router);
         if (context.path) {
-            const router = new Router({
-                name
-            });
-            plugin.install(router);
             this.use(context.path, router);
-            return this;
+        } else {
+            this.use(router);
         }
-        plugin.install(this);
         return this;
     }
     // --------------------------------------------------