# @ark7/router

> Ark7 Router layer framework.

Latest version **1.0.10** (published 2023-02-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @ark7/router
pnpm add @ark7/router
yarn add @ark7/router
bun add @ark7/router
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2023-02-17 |
| First published | 2021-04-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 98.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | yz@ark7.com |
| Maintainers | ark7_inc |
| Keywords | Router, Ark7 |

## Links

- npm: https://www.npmjs.com/package/@ark7/router
- Repository: https://github.com/ark7-technology/router
- Homepage: https://github.com/ark7-technology/router#readme
- Issues: https://github.com/ark7-technology/router/issues
- npm.io page: https://npm.io/package/@ark7/router

## Dependencies (9)

- [debug](https://npm.io/package/debug.md) ^4.3.1
- [koa-router](https://npm.io/package/koa-router.md) ^10.0.0
- [underscore](https://npm.io/package/underscore.md) ^1.13.1
- [object-path](https://npm.io/package/object-path.md) ^0.11.5
- [@types/debug](https://npm.io/package/@types/debug.md) ^4.1.5
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [@types/koa-router](https://npm.io/package/@types/koa-router.md) ^7.4.2
- [@types/underscore](https://npm.io/package/@types/underscore.md) ^1.11.1
- [@types/object-path](https://npm.io/package/@types/object-path.md) ^0.11.0

## 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

- 1.0.10 (latest) — 2023-02-17
- 1.0.8 — 2022-07-25
- 1.0.6 — 2021-06-19
- 1.0.5 — 2021-04-21
- 1.0.3 — 2021-04-18
- 1.0.2 — 2021-04-17
- 1.0.1 — 2021-04-17
- 1.0.0 — 2021-04-17

## README

# @ark7/router

> `@ark7/router` is class-oriented routing framework which is built on top of [koa](https://koajs.com/) and [koa-router](https://github.com/koajs/router).

## Usage

### Basic Usage

```typescript
@Config({
  prefix: '/users',
})
class User extends A7Controller {
  @Post('/')
  create = models.Users.createMiddleware({});

  @Get('/')
  @Permission({ roles: [Roles.ADMIN] })
  find = models.Users.findMiddleware({});

  @SubController('/users/:userId/topics')
  topics = Topics;
}
```

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