快速上手
快速开始使用 @ikenxuan/amagi
快速上手
本指南将帮助你快速了解 amagi 的基本用法。
基本用法
1. 创建客户端实例
import from '@ikenxuan/amagi'
// 创建客户端实例，绑定各平台 Cookie
const = ({
: {
: 'SESSDATA=xxx; bili_jct=yyy; ...',
: 'ttwid=...; ...',
: 'did=...; ...',
: 'a1=...; ...',
},
: {
// 可选：自定义请求配置
: { 'User-Agent': 'Mozilla/5.0 ...' }
}
})2. 获取数据
使用 fetcher API 获取数据（推荐）：
// 获取视频信息
const = await ...({
: 'BV1xx411c7mD'
})
if (.) {
.(.)
}
// 获取评论
const = await ...({
: '170001',
: 1,
: 20
})// 获取作品数据
const = await ...({
: '1234567890123456789'
})
// 聚合解析（自动识别类型）
const = await ...({
: '1234567890123456789'
})
// 获取评论
const = await ...({
: '1234567890123456789',
: 20
})// 获取作品信息
const = await ...({
: '3xqxxxxxx'
})
// 获取评论
const = await ...({
: '3xqxxxxxx'
})// 获取笔记数据
const = await ...({
: '64xxxxxxxx',
: 'xsec_xxx'
})
// 获取评论
const = await ...({
: '64xxxxxxxx',
: 'xsec_xxx'
})3. 启动 HTTP 服务
一行代码启动本地 HTTP 服务：
import from '@ikenxuan/amagi'
({
: {
: 'SESSDATA=xxx; ...',
: 'ttwid=...; ...',
: 'did=...; ...',
: 'a1=...; ...',
}
}).(4567)
// 访问 http://localhost:4567/
// API 文档：https://amagi.apifox.cn静态方法调用
如果不想创建实例，也可以直接使用静态方法：
import from '@ikenxuan/amagi'
// 需要手动传递 cookie
const = await ..(
{ : 'BV1xx411c7mD' },
'SESSDATA=...'
)类型模式
amagi 支持两种类型模式：
// 宽松模式 (默认) - 返回 any 类型
const = await ...({
: 'BV1xx411c7mD'
})
.data// 严格模式 - 返回完整类型定义
const = await ...({
: 'BV1xx411c7mD',
: 'strict'
})
.data事件监听
amagi v6 采用事件驱动架构，你可以监听各种事件：
import from '@ikenxuan/amagi'
const = ({ : { : '', : '', : '', : '' } })
// 监听 API 成功事件
..('api:success', () => {
.(`[${.}] ${.} 成功，耗时 ${.}ms`)
})
// 监听 API 错误事件
..('api:error', () => {
.(`[${.}] ${.} 失败: ${.}`)
})
// 监听日志事件
..('log:info', () => {
.(.)
})