Awesome
tiny-bilibili-ws
特点
- 开箱即用
- 同时支持浏览器和 NodeJs 环境
- 开箱即用的 Typescript 类型提示
- 轻量级的包体积
文档
阅读 文档 查看更多信息.
安装
pnpm install tiny-bilibili-ws
简单使用
在 Nodejs 中使用
import { KeepLiveWS, toMessageData } from 'tiny-bilibili-ws'
const room = 652581
const live = new KeepLiveWS(room, {
// 触发风控后，你会无法获取弹幕发送者的用户名，详情可见：https://github.com/ddiu8081/blive-message-listener/issues/29， 传入以下参数即可解除
headers: {
Cookie: 'xxx', // 从 Bilibili 网页版获取
},
uid: 0, // 你的 Cookie 对应的 UID
})
live.runWhenConnected(() => {
console.log(`正在监听 ${room}`) // 连接成功后才会触发
})
live.on('heartbeat', (online) => {
console.log('人气值: ', online)
})
live.on('DANMU_MSG', (danmu) => {
console.log(toMessageData(danmu))
})
live.on('error', (e) => {
console.error('错误: ', e)
})
live.on('close', () => {
console.log(`退出监听 ${room}`)
})
在浏览器中使用
import { KeepLiveWS } from 'tiny-bilibili-ws/browser'
// 因为存在跨域问题, Bilibili API 不能在浏览器中访问，现在需要手动传入 key 和 url
// 例子可以参考 https://github.com/starknt/tiny-bilibili-ws/blob/master/playground/src/App.vue#L13
const room = 652581
const live = new KeepLiveWS(room, {
url: 'xxx',
key: 'xxx',
})
live.runWhenConnected(() => {
console.log(`正在监听 ${room}`) // 连接成功后才会触发
})
live.on('heartbeat', (online) => {
console.log('人气值: ', online)
})
live.on('DANMU_MSG', (danmu) => {
console.log(toMessageData(danmu))
})
live.on('error', (e) => {
console.error('错误: ', e)
})
live.on('close', () => {
console.log(`退出监听 ${room}`)
})
Credits
Inspired by https://github.com/simon300000/bilibili-live-ws
参考资料
Bilibili API: https://github.com/lovelyyoshino/Bilibili-Live-API/blob/master/API.WebSocket.md