HyperExpress: High Performance Node.js Webserver
Fork Notes:
Changes in this fork
- This fork enables the ability to deregister routes while the server is running for dynamic processing
- Routed is now an instance of event emitter for event driven applications
uWebSockets.js
Powered by
Motivation
HyperExpress aims to be a simple yet performant HTTP & Websocket Server. Combined with the power of uWebsockets.js, a Node.js binding of uSockets written in C++, HyperExpress allows developers to unlock higher throughput for their web applications with their existing hardware. This can allow many web applications to become much more performant on optimized data serving endpoints without having to scale hardware.
Some of the prominent highlights are:
- Simplified HTTP & Websocket API
- Server-Sent Events Support
- Multipart File Uploading Support
- Modular Routers & Middlewares Support
- Multiple Host/Domain Support Over SSL
- Limited Express.js API Compatibility Through Shared Methods/Properties
See > [Benchmarks]
for performance metrics against other webservers in real world deployments.
Documentation
HyperExpress requires Node.js version 16+
and can be installed using Node Package Manager (npm
).
npm i hyper-express
- See
> [Examples & Snippets]
for small and easy-to-use snippets with HyperExpress. - See
> [Server]
for creating a webserver and working with the Server component. - See
> [Router]
for working with the modular Router component. - See
> [Request]
for working with the Request component made available through handlers. - See
> [Response]
for working with the Response component made available through handlers. - See
> [Websocket]
for working with Websockets in HyperExpress. - See
> [Middlewares]
for working with global and route-specific Middlewares in HyperExpress. - See
> [SSEventStream]
for working with Server-Sent Events based streaming in HyperExpress. - See
> [MultipartField]
for working with multipart requests and File Uploading in HyperExpress. - See
> [SessionEngine]
for working with cookie based web Sessions in HyperExpress. - See
> [LiveDirectory]
for implementing static file/asset serving functionality into HyperExpress. - See
> [HostManager]
for supporting requests over muliple hostnames in HyperExpress.
Testing Changes
To run HyperExpress functionality tests locally on your machine, you must follow the steps below.
- Clone the HyperExpress repository to your machine.
- Initialize and pull any submodule(s) which are used throughout the tests.
- Run
npm install
in the root directory. - Run
npm install
in the/tests
directory. - Run
npm test
to run all tests with your local changes.