https://github.com/saber2pr/koa

koa in typescript
https://github.com/saber2pr/koa

koa typescript

Last synced: about 1 month ago
JSON representation

koa in typescript

• Host: GitHub
• URL: https://github.com/saber2pr/koa
• Owner: Saber2pr
• Created: 2019-04-19T14:43:34.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-05-17T12:39:01.000Z (over 5 years ago)
• Last Synced: 2024-12-08T16:10:04.418Z (about 2 months ago)
• Topics: koa, typescript
• Language: TypeScript
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @saber2pr/koa

[![npm](https://img.shields.io/npm/v/@saber2pr/koa.svg?color=blue)](https://www.npmjs.com/package/@saber2pr/koa)

> koa in typescript.

```bash

# from npm

npm install @saber2pr/koa

# from github

git clone https://github.com/Saber2pr/-saber2pr-koa.git

```

## API

1. compose

   > 组合多个 Job

2. Koa

   > 创建一个应用

## Koa.body

这是个很重要的 API，返回 Koa 应用的 reducers !

它能用来做什么我想你已经猜到了 !

It' s a very useful api, it returns koa-app' s reducers!

I think you have known what it does mean.

# Koa

```ts

const user = Koa()

  .use(async (ctx, next) => {

    if (ctx.request.url === '/user') {

      ctx.response.end('user!')

    } else {

      await next()

    }

  })

  .use(async (ctx, next) => {

    if (ctx.request.url === '/user/saber2pr') {

      ctx.response.end('saber2pr!')

    } else {

      await next()

    }

  })

// main app

Koa({ version: '0.0.1' })

  .use(async (ctx, next) => {

    if (ctx.request.url === '/') {

      ctx.response.end('Hello World!')

    } else {

      await next()

    }

  })

  .use(async (ctx, next) => {

    if (ctx.request.url === '/version') {

      ctx.response.end(ctx.version)

    } else {

      await next()

    }

  })

  // look here!

  .use(user.body())

  .listen(3000, () => console.log('http://localhost:3000'))

```

# Notice(\*)

- Typescript 的函数参数类型是双向协变的，这不安全！

  例如上面的 user.body()，它所依赖的 ContextType 需要主入口程序的 Context 提供，如果允许双向协变，它不会报错！

  强烈建议开启：--strictFunctionTypes

  ```json

  {

    "compilerOptions": {

      "strictFunctionTypes": true

    }

  }

  ```

- Koa()中参数对象的 this

  建议开启 noImplicitThis

  ```json

  {

    "compilerOptions": {

      "noImplicitThis": true

    }

  }

  ```

---

## start

```bash

npm install

```

```bash

npm start

npm test

```

> Author: saber2pr

---

## develope and test

> you should write ts in /src

> you should make test in /src/test

> export your core in /src/index.ts!