# chat-koa

**Repository Path**: boboanzuiniubi/chat-koa

## Basic Information

- **Project Name**: chat-koa
- **Description**: 聊天室后台
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-21
- **Last Updated**: 2021-11-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# v0.0.1 测试用的，只是调通了接口，可以试试

目前所有消息都是一个字符串，下个版本再去处理媒体消息

## ws 链接方式

请求 koa 后台

ws 地址 `ws://ip:port/ws-chat`

## 消息类型

目前只有 3 类消息：客户端广播`chat-message`消息，修改链接信息`modify-uinfo` 和服务端提醒`attention-message`消息

示例  
客户端广播：

```json
{
    "from": "匿名",
    "type": "chat-message",
    "data": {
        "type": "text",
        "data": "你好呀，我是匿名"
    }
}
```

修改昵称
```json
{
    "from": "匿名",
    "type": "modify-uinfo",
    "data": {
        "name": "小飞侠"
    }
}
```

服务端提醒：
```json
{
    "from": "system",
    "type": "attention-message",
    "data": {
        "action": "text",
        "data": "你好呀，我是匿名"
    }
}
```

### 客户端广播

客户端广播用于每个 chat 客户端发送信息用，当 type 是 chat-message 时，是客户端消息  
后台收到客户端消息时，会无条件转发给所有链接

客户端消息是一个 send 一个 json 格式的字符串，需要 parse 去解析里面的信息。

### 服务端提醒

服务端会在
1. 登陆成功  
2. 修改昵称成功  

时，发送服务端提醒