\n\n# REserve 2️⃣\n\n[](https://github.com/ArnaudBuchholz/reserve/actions/workflows/node.js.yml)\n\n[](https://standardjs.com)\n[](https://packagequality.com/#?package=reserve)\n[](https://snyk.io/test/github/ArnaudBuchholz/reserve?targetFile=package.json)\n[](https://www.npmjs.org/package/reserve)\n[](https://packagephobia.now.sh/result?p=reserve)\n[](https://packagephobia.com/result?p=reserve)\n[](https://opensource.org/licenses/MIT)\n[](https://app.fossa.com/projects/git%2Bgithub.com%2FArnaudBuchholz%2Freserve?ref=badge_shield)\n[](https://github.com/ArnaudBuchholz/reserve/blob/main/docs/README.md)\n[](https://github.com/ArnaudBuchholz/reserve/blob/main/reserve/CHANGELOG.md)\n\n> A **lightweight** web server **configurable** with regular expressions. It can also be **embedded** and **extended**. The name comes from the combination of `RE` for regular expressions and `serve`.\n\n# 🍁 Rational\n\nInitially started to build a local **development environment** where static files are served and resources can be fetched from remote repositories, this **tool** is **versatile** and can support different scenarios :\n- A simple web server,\n- A reverse proxy,\n- A server that aggregates several sources,\n- ...\n\nBy defining **an array of mappings**, one can decide how the server will process the incoming requests. Each mapping associates **matching** criteria *(method selection, url matching using \n[regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp))* to a **handler** that will answer the request.\n\nThe configuration syntax favors **simplicity** without dropping flexibility.\n\nFor instance, the definition of a server that **exposes files** of the current directory but **forbids access** to the directory `private` consists in :\n\n```json\n{\n \"port\": 8080,\n \"mappings\": [{\n \"match\": \"^/private/\",\n \"status\": 403\n }, {\n \"match\": \"^/(.*)\",\n \"file\": \"./$1\"\n }, {\n \"status\": 404\n }]\n}\n```\n\n> Example of `reserve.json` configuration file\n\n# 💿 Usage\n\n## Command line\n\nThe package declares the executable `reserve` :\n\n* By default, it will look for a file named `reserve.json` in the current working directory\n* One or more configuration files name can be specified using `--config `\n\n## Embedded\n\nThe server can be embedded in an application using the `serve` export :\n\n```javascript\nconst { serve } = require('reserve')\n\nserve({\n port: 8080,\n mappings: [{\n match: /^\\/(.*)/,\n file: '$1'\n }, {\n \"status\": 404\n }]\n})\n .on('ready', ({ url }) => {\n console.log(`Server running at ${url}`)\n })\n```\n\n> Embedding `reserve` in a custom application (CommonJS)\n\nThe resulting [object](https://github.com/ArnaudBuchholz/reserve/blob/main/docs/serve.md) exposes a method similar to the [EventEmitter::on method](https://nodejs.org/api/events.html#emitteroneventname-listener) and throws events with parameters, see [Server events](https://github.com/ArnaudBuchholz/reserve/blob/main/docs/events.md).\nIt also exposes a `close` method *(returning a `Promise` resolved when all pending requests are completed)* to shutdown the server.\n\nThe package also gives access to the configuration reader :\n\n```javascript\nimport { read, serve } from 'reserve'\n\nread('reserve.json')\n .then(configuration =>\n serve(configuration)\n .on('ready', ({ url }) => {\n console.log(`Server running at ${url}`)\n })\n )\n```\n\n> Embedding `reserve` in a custom application (ESM)\n\nAnd a default log output *(verbose mode will dump all redirections)* :\n\n```javascript\nimport { log, read, serve } from 'reserve'\n\nread('reserve.json')\n .then(configuration =>\n log(serve(configuration), /*verbose: */ true)\n )\n```\n\n> Embedding `reserve` with the default logger (ESM)\n\n# ⚖️ License\n\nThe package is licensed MIT and has **no** dependencies.\n\n# 📚 Documentation\n\nGo to this [page](https://github.com/ArnaudBuchholz/reserve/tree/master/docs/README.md) to access documentation and articles about REserve.\n\n[⚠️ From v1 to v2](https://github.com/ArnaudBuchholz/reserve/tree/master/docs/v1_to_v2.md)\n","readmeFilename":"README.md"}
![\"REserve](\"https://arnaudbuchholz.github.io/gfx/REserve.png\")
\n