简介

这里是 Python 模块 bilibili-api 的 Typescript 克隆，适用于 JS/TS

注意：本仓库全都是异步操作，而且是 ajax，就是那种代码跑完了结果你的结果才刚刚出来的那种，不 await 后果自负。

如果您是新手，请务必看完这个 readme，里面有许多重要的信息。

特色

• 全面支持 javascript 和 typescript
• 可使用代理，绕过 b 站风控策略。
• 全面支持 BV 号（bvid），同时也兼容 AV 号（aid）。
• 调用简便，函数命名易懂，代码注释详细。
• 依赖少，无需第三方命令行工具，装完即用，无需其他配置。
• 更多的 API 敬请期待！

快速上手

首先，使用以下命令安装：

$ npm install bilibili-api-ts

或者在 package.json 中添加依赖。

接下来让我们获取视频播放量等信息：

const video = require("bilibili-api-ts/video.js");

// 实例化 Video 类
var v = new video.Video({
    bvid: "BV1uv411q7Mv"
});

(async function(){
    console.log(await v.get_info());
})();

输出（已格式化，已省略部分）：

{
    "bvid": "BV1uv411q7Mv",
    "aid": 243922477,
    "videos": 1,
    "tid": 17,
    "tname": "单机游戏",
    "copyright": 1,
    "pic": "https://i2.hdslb.com/bfs/archive/82e52df9d0221836c260c82f2890e3761a46716b.jpg",
    "title": "爆肝９８小时！在 MC 中还原糖调小镇",
    "pubdate": 1595203214,
    "ctime": 1595168654,
    ...and more
}

如何给这个视频点赞？我们需要登录自己的账号。

这里设计是传入一个 Credential 类，获取所需的信息参照：[获取 Credential 类所需信息][get-credential]

下面的代码将会给视频点赞

const bilibili = require("./bilibili-api-ts");
const video = require("./bilibili-api-ts/video.js");

// 实例化 Video 类
var v = new video.Video({
    bvid: "BVxxxxxxxxxx", 
    credential: new  bilibili.Credential({
        sessdata: "xxx", 
        bili_jct: "xxx", 
        dedeuserid: "xxx"
    })
});

(async function(){
    await v.like({
        status: true
    });
})();

FA♂Q

Q: 关于 API 调用的正确姿势是什么？

A: API 调用传参方式请看下面的举例：

// 错误 1: 传参
// 设 video.get_info 函数的参数是一个字典，字典的 bvid 项为稿件 BVID。
// 函数定义：get_info({bvid}: {bvid: string})
/** 
 * 所有的参数传入请传入一个字典，这样子可以换传参顺序、指名传参。
 * 传参像这样：get_info({参数名1: 参数1, 参数名2: 参数2}) -> get_info({bvid: 稿件 BVID})
 * 请不要直接传参数，参数需要放在字典里，而且需要表明好键，不能不标键。
 */ 

// 推荐
video.get_info({bvid:"BV1uv411q7Mv"})

// 当然也可以这样
video.get_info({"bvid":"BV1uv411q7Mv"})

// 不可以！
video.get_info({"BV1uv411q7Mv"}) // 没有标明键(bvid)

// 自己看 IntelliCode 的提示吧。
video.get_info("BV1uv411q7Mv") // 传入字典啊！
// ----------------------------------------------------------
// 错误 2: 每个函数都得传参
// 设 video.Video.prototype.get_aid 函数操作不用传任何参数：
// 函数定义：get_aid({}){...}，仍然加一个空字典当参数
/*
    因为 JS/TS 的迷惑设计，函数都不能指名传参。
    因此这里的设计是每一个函数都传入一个字典，像这样：{参数名1: 参数1, 参数名2: 参数2}，不用传参的函数暂时也还没有加上一个字典当参数。
    后来实在因为强迫症，把不用参数的函数都加了一个空字典当参数，原来 get_aid() 变成 get_aid({})，这样的确有个好处：随便传参不报错。
*/

// 可以
video.get_aid({})

// 不会错
video.get_aid({bvid: "我是个 SB"})

// 建议不要这么做
video.get_aid()

>如果有看不懂的地方，可以自己打一下示例代码(最好加上 IntelliCode 或在带实时提示的 Node REPL 下)，这样子自然而然就懂了。 每一个函数请务必都传一下放着参数的字典。

Q: 为什么会提示 412 Precondition Failed ？

A: 你的请求速度太快了。造成请求速度过快的原因可能是你写了高并发的代码。

这种情况下，你的 IP 会暂时被封禁而无法使用，你可以设置代理绕过。

import { set_proxy, Proxy } from "bilibili-api-ts"
set_proxy(new Proxy({
    host: "代理网址", 
    port: "代理端口", 
    username: "用户名（可选）", 
    password: "密码（可选)"
}))

Q: 怎么没有我想要的功能？

A: 你可以发 Issue 来提交你的需求，但是，最好的办法是自己写（懒）

Q: 我有一个大胆的想法，如何给代码库贡献？

A: 请先 clone 本仓库一份，然后从 main 分支新建一个分支，在该分支上工作。 如果你觉得已经可以了，请向项目仓库的 develop 分支发起 Pull request。 如果你不明白这些操作的话，可以百度。完整指南：CONTRIBUTING.md

Q: 稳定性怎么样？

A: 由于该模块比较特殊，是爬虫模块，如果 b 站的接口变更，可能会马上失效。因此请始终保证是最新版本。如果发现问题可以提 [Issues][issues-new]。

get-credential