bilibili-ws-client

适用于 Bilibili 直播的 WebSocket 客户端。

可用于实时获取弹幕 DANMU_MSG、收到礼物 SEND_GIFT、开播 LIVE、下播 PREPARING 等信息。

起步

bilibili-ws-client 支持以 CommonJS 或 ESM 的方式使用。

通过以下方式安装

npm install bilibili-ws-client

在 node.js 使用

[!TIP]
buvid 通过 https://api.bilibili.com/x/frontend/finger/spi 获取
key 通过 https://api.live.bilibili.com/xlive/web-room/v1/index/getDanmuInfo?id=${roomId} 获取

作为 ESM 模块使用：

import Client from 'bilibili-ws-client';

作为 CommonJS 模块使用：

const Client = require('bilibili-ws-client');

const sub = new Client({
  uid: 0, // 留空或为 0 代表访客，无法显示弹幕发送用户
  roomid: 1,
  protover: 3,
  buvid: '', // b_3
  platform: 'web',
  type: 2,
  key: '', // token
});

sub.on('open', () => {
  // ...
  console.log('authorized');
});

sub.on('close', () => {
  // ...
});

sub.on('message', ({ ver, op, cmd, body, ts }) => {
  if (op === 3) {
    console.log('online: ' + body);
  } else if (op === 5) {
    switch (cmd) {
      case 'LIVE':
        // 开播
        // ...
        break;
      case 'PREPARING':
        // 闲置（下播）
        // ...
        break;
      case 'DANMU_MSG':
        console.log(body);
        break;
      default:
        break;
    }
  } else {
    // ...
    console.log('op: ' + op);
    console.log('body: ' + body);
  }
});

sub.on('error', (err) => {
  throw new Error(err);
});

在前端项目使用

作为 ESM 模块使用：

import Client from 'bilibili-ws-client';

const sub = new Client(roomId);
// ...

配置

• token
• logger
• maxConnectTimes
• delay

token

Type:

type Token =
  | number // roomId
  | Partial<{
      uid: number;
      roomid: number; // roomId
      protover: Ver; // 1 | 2 | 3
      buvid: string;
      platform: string; // 'web'
      clientver: string;
      type: number;
      key: string;
    }>;

需要连接的房间号或一个包含登录信息的对象。

logger

Type:

type logger = boolean | LoggerFn | undefined;

默认值：false

是否记录日志，默认通过 console.log 输出，支持传递自定义函数。

maxConnectTimes

Type:

type maxConnectTimes = number | undefined;

默认值：6

当 WebSocket 触发 close 时，最多重试再次连接的次数，达到上限后将重置延时。

设置为 0 以禁用自动重试。

delay

Type:

type delay = number | undefined;

默认值：3000

当 WebSocket 触发 close 时，间隔特定毫秒后重试，每次触发后 * 2，达到 maxConnectTimes 上限将重置。

开发

npm run prettier
npm run build