# mango

**Repository Path**: SunShineGo/mango

## Basic Information

- **Project Name**: mango
- **Description**: 一个基于elysia的we框架
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-02
- **Last Updated**: 2025-03-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mango

## 简介

**Mango** 是一个轻量级、高性能的 Web 框架，在`Elysia`的基础上进行的二次开发。它在既拥有智能类型提示的情况下又提供了一套完整的mvc开发方式

## 特性

- **高性能**：基于 Bun 的高效运行时，提供卓越的性能。
- **简单易用**：直观的 API 设计，让开发者可以快速上手。
- **生态**：基于Elysia改造而来，完全适配Elysia的插件、中间件、生态。
- **内置路由**：灵活的路由系统，支持动态路由和中间件。
- **TypeScript 支持**：内置对 TypeScript 的支持，提升开发体验。
- **支持 WebSocket**：轻松实现WebSocket功能。
- **支持 Cron**：轻松实现定时任务功能。

## 安装

```bash
git clone xxx # 该项目地址
```

## 快速开始

以下是一个使用 Mango 构建基本 Web 服务器的示例：

```typescript

import { Controller, Get} from '@mango/core'
import type { Mango } from '@mango/types'
@Controller({
  name: '测试模块',
  prefix: '/test',
  detail: {
    description: '这是一段测试模块的备注',
    tags: ['测试'],
  },
})
export default class DemoController {
  @Get('/test')
  login(data: Mango.Context) {
    return 'Hello Word!'
  }
}
```

## 依赖注入
```typescript
import { Controller, Get} from '@mango/core'
import type { Mango } from '@mango/types'
@Controller({
  name: '测试模块',
  prefix: '/test',
  detail: {
    description: '这是一段测试模块的备注',
    tags: ['测试'],
  },
})
export default class DemoController {

  @Get()
  test(store: Mango.Context) {
    
  }
}
```

## 路由

Mango 提供了一个简单的路由系统，以下是一些常用的路由示例：

> 支持Get, Post, Put, Delete, All, Option, Patch, Custom请求
> 
> 其中被All装饰会命中所有的请求
> 
> Custom装饰器则是自定义请求方法

```typescript
import { Controller, Get, Post, Put, Delete, All, Option, Patch, Custom} from '@mango/core'
import type { Mango } from '@mango/types'
@Controller({
  name: '测试模块',
  prefix: '/test',
  detail: {
    description: '这是一段测试模块的备注',
    tags: ['测试'],
  },
})
export default class DemoController {
  @Get('/test')
  test1(data: Mango.Context) {
    return 'Hello Word!'
  }

  @Post('/test')
  test2(data: Mango.Context) {
    return 'Hello Word!'
  } 
}
```

## 定时任务
> 基于`@elysiajs/cron`封装

```typescript
import { Controller, Get, Cron} from '@mango/core'
import type { Mango } from '@mango/types'
@Controller({
  name: '测试模块',
  prefix: '/test',
  detail: {
    description: '这是一段测试模块的备注',
    tags: ['测试'],
  },
})
export default class DemoController {
  @Cron({
    name: 'task1',
    pattern: '*/20 * * * * *',
  })
  cronTask() {
    console.log('任务1')
  }

  @Get('/stop/task')
  stopTask({ stopCronTask }: Mango.Context) {
    stopCronTask('task1')
    return '停止任务1'
  }
}
```

## WebSocket
```typescript
import { Controller, WebSocket} from '@mango/core'
import type { Mango } from '@mango/types'
@Controller({
  name: '测试模块',
  prefix: '/test',
  detail: {
    description: '这是一段测试模块的备注',
    tags: ['测试'],
  },
})
export default class DemoController {
  @WebSocket('/ws', {
    body: t.Object({
      name: t.String(),
      age: t.Number(),
    }),
  })
  websocket(ws: Mango.WebSocket, message: any) {
    ws.send(message)
  }
}
```

## 自定义装饰器
> 注意，自定义装饰器必须在请求装饰器下面
```typescript
import { Controller, Get, Post, Put, Delete, All, Option, Patch, Custom} from '@mango/core'
import type { Mango } from '@mango/types'
import { createParameterDecorator } from '@mango/core'
import { HttpStatus, JsonResponse } from '@mango/utils'

const test = createParameterDecorator<{
  body: any
}>((context) => {
  if (!context.body.name) {
    return JsonResponse(
      {
        code: HttpStatus.BAD_REQUEST,
        msg: '缺少名字',
      },
      HttpStatus.BAD_REQUEST,
    )
  }
  return true
})

@Controller({
  name: '测试模块',
  prefix: '/test',
  detail: {
    description: '这是一段测试模块的备注',
    tags: ['测试'],
  },
})
export default class DemoController {
  @Post('/test')
  @test
  test1(data: Mango.Context) {
    return 'Hello Word!'
  }
}
```


> 当前版本的`elysia`存在类型bug，在代码中忘记添加了`NoInfer`类型工具
> 需要手动添加
```ts
export type NoInfer<T> = T extends infer U ? U : never;
```

## 贡献

欢迎贡献

## 许可证

该项目采用 MIT 许可证

```