ultimate-express 1.2.30 → 1.3.0

package/README.md

@@ -16,7 +16,7 @@ To make sure µExpress matches behavior of Express in all cases, we run all test
 
 Similar projects based on uWebSockets:
 
-- `express` on Bun - since Bun uses uWS for its HTTP module, Express is about 2-3 times faster than on Node.js, but still slower than µExpress because it doesn't do uWS-specific optimizations.
+- `express` on Bun - since Bun uses uWS for its HTTP module, Express is about 2-3 times faster than on Node.js, but still almost 2 times slower than µExpress because it doesn't do uWS-specific optimizations.
 - `hyper-express` - while having a similar API to Express, it's very far from being a drop-in replacement, and implements most of the functionality differently. This creates a lot of random quirks and issues, making the switch quite difficult. Built in middlewares are also very different, middlewares for Express are mostly not supported.
 - `uwebsockets-express` - this library is closer to being a drop-in replacement, but misses a lot of APIs, depends on Express by calling it's methods under the hood and doesn't try to optimize routing by using native uWS router.
 
@@ -61,6 +61,7 @@ Also tested on a [real-world application](https://nekoweb.org) with templates, s
 In a lot of cases, you can just replace `require("express")` with `require("ultimate-express")` and everything works the same. But there are some differences:
 
 - `case sensitive routing` is enabled by default.
+- a new option `catch async errors` is added. If it's enabled, you don't need to use `express-async-errors` module.
 - request body is only read for POST, PUT and PATCH requests by default. You can add additional methods by setting `body methods` to array with uppercased methods.
 - For HTTPS, instead of doing this:  
 ```js
@@ -301,9 +302,10 @@ Almost all middlewares that are compatible with Express are compatible with µEx
 - ✅ [express-subdomain](https://npmjs.com/package/express-subdomain)
 - ✅ [vhost](https://npmjs.com/package/vhost)
 
-Middlewares that are confirmed to not work:
+Middlewares and modules that are confirmed to not work:
 
-- ❌ [compression](https://npmjs.com/package/compression) (doesn't error, but doesn't compress)
+- ❌ [compression](https://npmjs.com/package/compression) - doesn't error, but doesn't compress
+- ❌ [express-async-errors](https://npmjs.com/package/express-async-errors) - doesn't work, use `app.set('catch async errors', true)` instead.
 
 ## Tested view engines
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate-express",
-  "version": "1.2.30",
+  "version": "1.3.0",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {
@@ -31,6 +31,7 @@
     "uwebsockets",
     "uws"
   ],
+  "types": "src/types.d.ts",
   "author": "dimden.dev",
   "license": "Apache-2.0",
   "bugs": {
@@ -38,6 +39,7 @@
   },
   "homepage": "https://github.com/dimdenGD/ultimate-express#readme",
   "dependencies": {
+    "@types/express": "^4.0.0",
     "accepts": "^1.3.8",
     "bytes": "^3.1.2",
     "cookie": "^0.6.0",
@@ -68,6 +70,7 @@
     "exit-hook": "^2.2.1",
     "express": "^4.19.2",
     "express-art-template": "^1.0.1",
+    "express-async-errors": "^3.1.1",
     "express-dot-engine": "^1.0.8",
     "express-fileupload": "^1.5.1",
     "express-handlebars": "^8.0.1",

package/src/application.js

@@ -159,12 +159,12 @@ class Application extends Router {
     }
 
     enable(key) {
-        this.settings[key] = true;
+        this.set(key, true);
         return this;
     }
 
     disable(key) {
-        this.settings[key] = false;
+        this.set(key, false);
         return this;
     }
 

package/src/response.js

@@ -224,7 +224,7 @@ module.exports = class Response extends Writable {
         if(this.finished) {
             return;
         }
-        
+        this.writeHead(this.statusCode);
         this._res.cork(() => {
             if(!this.headersSent) {
                 const etagFn = this.app.get('etag fn');
@@ -286,7 +286,6 @@ module.exports = class Response extends Writable {
                 this.headers['content-type'] += '; charset=utf-8';
             }
         }
-        this.writeHead(this.statusCode);
         return this.end(body);
     }
     sendFile(path, options = {}, callback) {
@@ -784,4 +783,4 @@ function pipeStreamOverResponse(res, readStream, totalSize, callback) {
             if(res.socketExists) res.socket.emit('error', e);
         }
     });
-}
+}

package/src/router.js

@@ -485,7 +485,12 @@ module.exports = class Router extends EventEmitter {
                         const out = callback(req, res, next);
                         if(out instanceof Promise) {
                             out.catch(err => {
-                                throw err;
+                                if(this.get("catch async errors")) {
+                                    this._handleError(err, req, res);
+                                    return resolve(true);
+                                } else {
+                                    throw err;
+                                }
                             });
                         }
                     } catch(err) {

package/src/types.d.ts

@@ -0,0 +1,4 @@
+declare module 'ultimate-express' {
+    import express from '@types/express';
+    export = express;
+}