JSPM

hyper-express

6.4.11
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3957
  • Score
    100M100P100Q130933F
  • License MIT

High performance Node.js webserver with a simple-to-use API powered by uWebsockets.js under the hood.

Package Exports

  • hyper-express
  • hyper-express/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hyper-express) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

HyperExpress: High Performance Node.js Webserver

Powered by uWebSockets.js

NPM version NPM downloads Language grade: JavaScript GitHub issues GitHub stars GitHub license

Motivation

HyperExpress aims to be a simple yet perfomant 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 14+ 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.

  1. Clone the HyperExpress repository to your machine.
  2. Initialize and pull any submodule(s) which are used throughout the tests.
  3. Run npm install in the root directory.
  4. Run npm install in the /tests directory.
  5. Run npm test to run all tests with your local changes.

License

MIT