# egg-router-decorator2

> egg.js router decorator

Latest version **0.0.4** (published 2019-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-router-decorator2
pnpm add egg-router-decorator2
yarn add egg-router-decorator2
bun add egg-router-decorator2
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2019-08-13 |
| First published | 2019-06-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | JerrysShan |
| Maintainers | jerryshan2011 |
| Keywords | egg, router, decorator |

## Links

- npm: https://www.npmjs.com/package/egg-router-decorator2
- npm.io page: https://npm.io/package/egg-router-decorator2

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 0.0.4 (latest) — 2019-08-13
- 0.0.3 — 2019-06-12
- 0.0.2 — 2019-06-12
- 0.0.1 — 2019-06-12

## README

# egg-router-decorator2

## Introduction
  use decorator declare making eggjs router easy.

## Usage
```ts
// home.ts
import { Controller } from 'egg';
import { GET } from 'egg-router-decorator2';

class HomeController extends Controller {
  @GET('/')
  async heartbeat(): Promise<any> {
    this.ctx.body = 'hello world';
  }
}

export default HomeController;

// router.ts
import { initRouter } from 'egg-router-decorator2';

export default (app) => {
  initRouter(app, { prefix: '/api' });
};

```


## API

* GET(path,...middlewares)
* POST(path,...middlewares)
* PUT(path,...middlewares)
* DELETE(path,...middlewares)
* PATCH(path,...middlewares)
* OPTIONS(path,...middlewares)
* HEAD(path,...middlewares)
* Request(method,path,...middlewares)

   path \<string\>, required

   method: \<string\> ,'GET','PUT','POST','DELETE','PATCH','OPTIONS','HEAD',

  middlewares: \<Array[string]\> , names of eggjs middlewares


* initRouter(app: Application,options={prefix:''})

---
_Source: https://npm.io/package/egg-router-decorator2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._