# isamoyed

> 为 koa-router 提供装饰器。

Latest version **1.1.4** (published 2021-02-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install isamoyed
pnpm add isamoyed
yarn add isamoyed
bun add isamoyed
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2021-02-02 |
| First published | 2020-11-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 56.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | mav7 |

## Links

- npm: https://www.npmjs.com/package/isamoyed
- Repository: https://github.com/Tauleos/samoyed
- Homepage: https://github.com/Tauleos/samoyed#readme
- Issues: https://github.com/Tauleos/samoyed/issues
- npm.io page: https://npm.io/package/isamoyed

## Dependencies (4)

- [koa](https://npm.io/package/koa.md) ^2.13.0
- [koa-body](https://npm.io/package/koa-body.md) ^4.2.0
- [koa-router](https://npm.io/package/koa-router.md) ^10.0.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Recent versions

- 1.1.4 (latest) — 2021-02-02
- 1.1.3 — 2021-01-20
- 1.1.2 — 2021-01-20
- 1.1.1 — 2020-12-14
- 1.1.0 — 2020-11-18
- 1.0.3 — 2020-11-17
- 1.0.2 — 2020-11-17
- 1.0.1 — 2020-11-17
- 1.0.0 — 2020-11-16

## README

# Samoyed
>为 koa-router 提供装饰器。方便koa用户使用注解的方式定义路由

[![npm version](https://badge.fury.io/js/isamoyed.svg)](https://badge.fury.io/js/isamoyed)
[![NPM downloads](http://img.shields.io/npm/dy/isamoyed.svg?style=flat)](https://www.npmjs.com/package/isamoyed)

### 适用人群
- Koa 用户
- Typescript用户
- 使用之前请先阅读[注意事项](#注意事项)

### 安装
```
npm install --save isamoyed
```
### 使用

#### 非前缀模式(后期考虑干掉)
```js
import Koa from 'koa';

import { scan } from '../build/cmjs';
import path from 'path';
const app = new Koa();
// 初始化
const ControllerDir = path.resolve(__dirname, './controller');

await scan(app,controllerDir);

```
#### 前缀模式

```js
import Koa from 'koa';

import Samoyed from '../src';
import path from 'path';
const app = new Koa();
// 初始化
const ControllerDir = path.resolve(__dirname, './controller');
const sam = new Samoyed(app, ControllerDir, '/api');

sam.scan().then(() => {
  app.listen(3000);
});
```

### 装饰器使用示例
```
import { Controller, Ctx, Get, Ip, Post, Req } from '../../build';
import { Context, Request } from 'koa';

@Controller('/goods')
export default class GoodsController {
  @Post('/add')
  addAction(@Ctx() ctx: Context, @Ip() ip: string) {
    return { code: 0, success: true };
  }
  @Get('/list')
  listAction(@Req() req: Request) {
    return { success: false };
  }
}
```

### API

- scan(app,ControllerDir):全局扫描控制器进行路由注册
    - app: Koa 实例
    - ControllerDir: 控制器文件所在目录，*目前只支持单层目录*
- Controller(path:string): 定义控制器的基础路由路径
- 支持 `GET POST PUT DELETE` 方法，可使用装饰器 `@GET @POST @PUT @DELETE`
- 支持通过注解`Ctx Request Req Response Res Query Body Param Headers Session File Files Ip `获取对应的属性 


### 注意事项

- `controllerDir` 目前只支持单层目录，暂时不支持目录嵌套。
- 示例中的`Action` 方法目前只支持返回json结构，暂时不支持重定向等操作。

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