https://github.com/montyanderson/trench
:large_orange_diamond: Simplistic, promise-based web framework for node.
https://github.com/montyanderson/trench
Last synced: 3 months ago
JSON representation
:large_orange_diamond: Simplistic, promise-based web framework for node.
- Host: GitHub
- URL: https://github.com/montyanderson/trench
- Owner: montyanderson
- License: mit
- Created: 2016-10-16T12:09:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-08T23:15:30.000Z (over 8 years ago)
- Last Synced: 2024-04-26T00:42:04.857Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# trench
[](https://travis-ci.org/montyanderson/trench)
:large_orange_diamond: Simplistic, promise-based web framework for node.
## Features
* Supports new [ES6 features](https://github.com/lukehoban/es6features) such as [Promises](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise) and [Sets](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Set).
* Supports all HTTP methods listed in [http.METHODS](https://nodejs.org/api/http.html#http_http_methods).
* Prioritises speed and simplicity over a large feature-set or extensive options.
* API modeled on the ever-popular [Express](http://expressjs.com/).
* In equivalent "Hello, World!" examples, it's *faster than both [hapi](http://hapijs.com/) and [Express](http://expressjs.com/)*.
## Usage
* Requires Node 6.0+
``` javascript
const Trench = require("trench");
const app = new Trench();
app.get("/", (req, res) => {
res.end("
Hello, World!
");
});
app.listen(8080);
```
### Recommended Modules
* [trench-session](https://github.com/montyanderson/trench-session)
### API
#### new Trench()
Returns a new app instance.
``` javascript
const app = new Trench();
```
#### Trench#use(function)
Specifices a middleware function to be used.
``` javascript
app.use((req, res) => {
res.locals.startTime = Date.now();
});
```
#### Trench.static(root)
Returns a middleware function for serving static files.
``` javascript
app.use(Trench.static(__dirname + "/static"));
```
#### Trench#get(path, [ function, [ function, [ function ]]])
Specifices a GET route for the given path.
``` javascript
app.get("/", (req, res) => {
res.locals.name = "Monty";
}, (req, res) => {
res.end(`Hi, ${res.locals.name}!`);
});
```