https://github.com/lc-cn/onebot-client

oneBot的client端封装
https://github.com/lc-cn/onebot-client

Last synced: 2 days ago
JSON representation

oneBot的client端封装

• Host: GitHub
• URL: https://github.com/lc-cn/onebot-client
• Owner: lc-cn
• License: mit
• Created: 2022-09-19T14:50:56.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-07T03:08:16.000Z (over 1 year ago)
• Last Synced: 2024-09-25T20:44:58.738Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://lc-cn.github.io/onebot-client/
• Size: 209 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# onebot-client

oneBot 客户端SDK

## Install

### 1 使用包管理器

```shell

npm i onebot-client

```

### 2 使用cdn链接

```html

```

## Usage

### 1. linkServer

```javascript

const {Client} = require('onebot-client')

const client=new Client(147258369,{

    remote_url:'ws://localhost:6700',// 你onebot启动时设置的websocket连接地址

    access_token:'',//鉴权token

})

client.start().then(()=>{

    // do sth

})

```

### 2. listen event

```javascript

client.on('message.private',(event)=>{

    event.reply('hello') // listen all private message, reply hello

})

client.pickFriend(22998833).on('message',(event)=>{

    event.reply('hi') // listen friend(22998833) reply hi

})

client.pickGroup(42342342).pickMember(532422).on('message',(event)=>{

    event.recall() // listen group(42342342) member(532422) message, recall that

})

```

### 3. send message

```javascript

client.sendPrivateMsg(22998833,'hello') // send hello to friend 22998833

client.sendGroupMsg(42342342,'hi') // send hi to group 42342342

```

### 4. getClient info

```javascript

client.getGroupList() // 

client.pickGroup(42342342).info // get groupInfo

client.getFriendList() //

client.pickFriend(22998833).info // get friendInfo

client.getGroupMemberList(42342342) // get groupMemberList

client.pickGroup(42342342).pickMember(22998833).info  // get memberInfo

```

### fix request/notice

```javascript

client.on('notice',(notice)=>{

    // fix all notice

})

client.on('request',(notice)=>{

    // fix all request

})

client.pickGroup(42342342).on('notice') // fix group(42342342) notice

client.pickGroup(42342342).on('request') // fix group(42342342) request

client.pickGroup(42342342).on('notice.increase') // fix group(42342342) increase notice

client.pickGroup(42342342).on('request.add') // fix group(42342342) add request

```

## more 

[TypeDocs](https://lc-cn.github.io/onebot-client/)