veloze/README.md

A modern and fast express-like webserver for the web

[![npm-badge][npm-badge]][npm]
[![actions-badge][actions-badge]][actions]
![types-badge][types-badge]

# veloze

[📃 Documentation][Documentation]

> A modern and fast express-like webserver for the web.

Allows you to:
- reuse connect (express) middlewares
- use secure defaults
- pick the pieces to build your server 
- use async middlewares like `async (req, res) => { ... }`

Comes with:
- a [Pure ESM Package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
- Stoppable HTTP2 server
- Fast Radix Tree Router
- Follows standards (lower-case headers, ...)
- failsafe connecting your handlers by catching thrown errors in middlewares
- Query-parser middleware to prevent HTTP parameter pollution
- Body-parser for form, json, raw content
- content-security-policy and reporting middleware
- HTTP to HTTPS redirect middleware
- cache-control middleware
- CORS middleware
- Cookie-parser and response helpers to set and clear cookies
- Too Busy middleware to prevent server from overload
- Support for server-side rendering engines
- Safe final handler to prevent info leakage from internal error exposure in
  responses
- res.send() to send any content with or without Etag generation
- res.json() to respond with a JSON object, with or without Etag generation
- Serve middleware to serve static files with brotli, gzip, deflate
  compression

Project Goals:
- Provide a fast and modern web-server
- Modular and un-opinionated.
- ESM only (no require)
- Follows Connect/Express middleware pattern `(req, res, next) => { ... }`
- Keep things simple
- Pure Javascript with the support of TS-types.
- Secure Defaults

Benchmarks:
- can be found in [veloze-benchmarks](https://github.com/commenthol/veloze-benchmarks)

Documentation:
- read more at [./docs/index.md][Documentation]

# license

MIT licensed

[npm-badge]: https://badge.fury.io/js/veloze.svg
[npm]: https://www.npmjs.com/package/veloze
[types-badge]: https://badgen.net/npm/types/veloze
[actions-badge]: https://github.com/commenthol/veloze/actions/workflows/ci.yml/badge.svg
[actions]: https://github.com/commenthol/veloze/actions/workflows/ci.yml

[Documentation]: https://github.com/commenthol/veloze/blob/main/docs/index.md