https://github.com/yviscool/ex-press
Web framework based on IoC and TypeScript
https://github.com/yviscool/ex-press
Last synced: 11 months ago
JSON representation
Web framework based on IoC and TypeScript
- Host: GitHub
- URL: https://github.com/yviscool/ex-press
- Owner: yviscool
- Created: 2020-05-21T09:44:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-02T03:09:14.000Z (about 6 years ago)
- Last Synced: 2025-02-27T11:42:38.883Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 106 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ex-press
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![coverage][coverage-image]][coverage-url]
[npm-image]: https://img.shields.io/npm/v/ex-press.svg?style=flat-square
[npm-url]: https://npmjs.org/package/ex-press
[travis-image]: https://travis-ci.org/yviscool/ex-press.svg?branch=master
[travis-url]: https://travis-ci.org/yviscool/ex-press
[coverage-url]: https://coveralls.io/github/yviscool/ex-press
[coverage-image]: https://coveralls.io/repos/github/yviscool/ex-press/badge.svg
ex-press is Node.js Web framework written by typescript, which uses IoC injection mechanism.
## QuickStart
see [ex-press docs][express] for more detail.
```js
import { Controller, Get, Post, Request, Body, Param, Del, Response, Provide, Inject } from 'ex-press';
import { UserService } from './service/user';
import { Response as Ctx } from 'express';
@Provide()
@Controller('/user')
export class UserController {
@Inject()
ctx: Ctx;
@Config('hello')
hello:string;
@Inject('userService')
userService: UserService
@Get('/')
async index(@Request() req) {
this.ctx.json(req.ip);
}
@Post('/')
async post(@Body() body, @Res() res) {
res.json(body);
}
@Get('/:id')
async getParam(@Param('id') id) {
return `get user ${id}`;
}
@Get('/service')
async service(@Param() param) {
const user = await this.userService.getUser();
return user;
}
}
```
### Web middleware in router
Now you can provide a middleware in you application (any directory)，such as src/app/middleware/api.ts.
```js
import { Provide, Config, WebMiddleware } from 'ex-press';
@Provide()
export class ApiMiddleware implements WebMiddleware {
@Config('foo')
foo;
resolve(): any {
return (req, res, next) => {
req.api = this.foo;
next();
};
}
}
```
use
```js
import { Controller, Get, Provide, Inject } from 'ex-press';
import { Response as Ctx } from 'express';
@Provide()
@Controller('/middleware', { middleware: ['apiMiddleware'] })
export class MiddlewareController {
@Inject()
ctx: Ctx;
@Get('/')
async index(@Request() req) {
this.ctx.send(req.api);
}
@Get('/part', { middleware: ['homeMiddleware'] })
async post(@Request() req) {
this.ctx.send(req.api + req.home);
}
}
```
[express]: https://expressjs.com