discover · compare · collections · requirements · contribute · feed · watching · stats · help with your tokens
kartikk221/hyper-express · source
Snapshot 0 · 2026-11-04T12:47:26Z · JavaScript · MIT
Content fingerprint
8b3c885fc3a5b46ad0b820ca23ccd246870809d7f6c690c1e8927a30753fe9f6GitHub description at capture
High performance Node.js webserver with a simple-to-use API powered by uWebsockets.js under the hood.
README at capture
# HyperExpress: High Performance Node.js Webserver #### Powered by [`uWebSockets.js`](https://github.com/uNetworking/uWebSockets.js/) <div align="left"> [](https://www.npmjs.com/package/hyper-express) [](https://www.npmjs.com/package/hyper-express) [](https://github.com/kartikk221/hyper-express/issues) [](https://github.com/kartikk221/hyper-express/stargazers) [](https://github.com/kartikk221/hyper-express/blob/master/LICENSE) </div> ## 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]`](https://web-frameworks-benchmark.netlify.app/result?l=javascript) for **performance metrics** against other webservers in real world deployments. ## Documentation HyperExpress v7 supports the active even-numbered Node.js release lines **22, 24, and 26** and can be installed using Node Package Manager (`npm`). HyperExpress remains CommonJS-only and preserves its existing snake_case API. ``` npm i hyper-express ``` HyperExpress uses the native uWebSockets.js addon. Its prebuilt binaries support Tier 1 macOS and Windows platforms, and glibc-based Tier 1 Linux distributions. Alpine Linux uses musl instead of glibc; plain Alpine and Alpine with `gcompat` are not supported because the native addon can terminate with `SIGSEGV`. Use a Debian or Ubuntu based Node.js image for reliable container deployments. - See [`> [Migrating from v6 to v7]`](./docs/Migration-v7.md) for breaking changes and newly exposed APIs. - See [`> [Native lifecycle contract]`](./docs/Native-Lifecycle.md) for the audited uWebSockets.js ownership, callback-memory, and option-range rules. - See [`> [Examples & Snippets]`](./docs/Examples.md) for small and **easy-to-use snippets** with HyperExpress. - See [`> [Server]`](./docs/Server.md) for creating a webserver and working with the **Server** component. - See [`> [Router]`](./docs/Router.md) for working with the modular **Router** component. - See [`> [Request]`](./docs/Request.md) for working with the **Request** component made available through handlers. - See [`> [Response]`](./docs/Response.md) for working with the **Response** component made available through handlers. - See [`> [Websocket]`](./docs/Websocket.md) for working with **Websockets** in HyperExpress. - See [`> [Middlewares]`](./docs/Middlewares.md) for working with global and route-specific **Middlewares** in HyperExpress. - See [`> [SSEventStream]`](./docs/SSEventStream.md) for working with **Server-Sent Events** based streaming in HyperExpress. - See [`> [MultipartField]`](./docs/MultipartField.md) for working with multipart requests and **File Uploading** in HyperExpress. - See [`> [SessionEngine]`](https://github.com/kartikk221/hyper-express-session) for working with cookie based web **Sessions** in HyperExpress. - See [`> [LiveDirectory]`](./docs/LiveDirectory.md) for implementing **static file/asset** serving functionality into HyperExpress. - See [`> [HostManager]`](./docs/HostManager.md) for supporting requests over **muliple hostnames** in HyperExpress. ## Encountering Problems? - HyperExpress is mostly compatible with `Express` but not **100%** therefore you may encounter some middlewares not working out of the box. In this scenario, you must either write your own polyfill or omit the middleware to continue. - The uWebsockets.js version header is disabled by default. You may opt-out of this behavior by setting an environment variable called `KEEP_UWS_HEADER` to a truthy value such as `1` or `true`. - Still having problems? Open an [`> [Issue]`](https://github.com/kartikk221/hyper-express/issues) with details about what led up to the problem including error traces, route information etc etc. ## Testing Changes To run HyperExpress functionality tests locally on your machine, you must follow the steps below. 1. Clone the HyperExpress repository to your machine. 2. Run `npm ci` in the root directory. Test-only dependencies are installed from the root lockfile. 3. Run `npm test` for runtime tests. 4. Run `npm run test:types` for positive and negative TypeScript fixtures. 5. Run `npm run test:load` for the heavier HTTP, multipart, abort, WebSocket, and memory stress gate. ## License [MIT](./LICENSE)