# bifroster-framework-koa-loader

> bifroster-framework-koa

Latest version **1.0.2** (published 2017-12-29) · 0 weekly downloads

## Install

```sh
npm install bifroster-framework-koa-loader
pnpm add bifroster-framework-koa-loader
yarn add bifroster-framework-koa-loader
bun add bifroster-framework-koa-loader
```

## 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.0.2 |
| Published | 2017-12-29 |
| First published | 2017-12-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | evio |

## Links

- npm: https://www.npmjs.com/package/bifroster-framework-koa-loader
- Repository: https://github.com/cevio/bifroster-framework-koa-loader
- Homepage: https://github.com/cevio/bifroster-framework-koa-loader#readme
- Issues: https://github.com/cevio/bifroster-framework-koa-loader/issues
- npm.io page: https://npm.io/package/bifroster-framework-koa-loader

## Dependencies (4)

- [koa](https://npm.io/package/koa.md) ^2.4.1
- [globby](https://npm.io/package/globby.md) ^7.1.1
- [is-type-of](https://npm.io/package/is-type-of.md) ^1.2.0
- [koa-router](https://npm.io/package/koa-router.md) ^7.3.0

## Recent versions

- 1.0.2 (latest) — 2017-12-29
- 1.0.1 — 2017-12-28
- 1.0.0 — 2017-12-28

## README

# Koa framework

基于Koa的应用架构。

## Install

```bash
npm install --save bifroster-framework-koa-loader
```

## Usage

**app.js**

```javascript
module.exports = require('bifroster-framework-koa-loader').bootstrap({
  service: {
    directory: 'service',
    match: ['**/*.js'],
    ignore: null,
    override: true
  },
  constroller: {
    directory: 'service',
    match: ['**/*.js'],
    ignore: null,
    override: true
  },
  middleware: {
    directory: 'service',
    match: ['**/*.js'],
    ignore: null,
    override: true
  },
  router: 'router'
});
```

### Service Controller and Middleware Layer Usage

`app/service/index-test-value.js`

```javascript
const { Service } = require('bifroster-framework-koa-loader');
module.exports = class testService extends Service {
  constructor(app) {
    super(app);
  }
  value() {
    return 2;
  }
}
```

Invoke:

```javascript
app.Service.indexTestValue;
app.Service.indexTestValue.value(); // 2
```

### Router auto layer

`app/router/index.js`:

```javascript
module.exports = (app,router) => {
  router.get('/', app.Controller.indexControllerTest.hello);
}
```
`app/router/test.js`:

```javascript
module.exports = (app, router) => {
  router.get('/', app.Controller.indexControllerTest.hello);
  router.get('/:id(\\d+)/user', app.Controller.indexControllerTest.b);
}
```

系统自动根据目录结构生成路由嵌套逻辑。

## 性能

所有执行都是服务启动前所做的，所以性能方面与一般KOA性能相同。不需要担心性能问题。

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