类型参考
类型索引
481 个公开导出的总索引，按页面分组
本页索引 481 个符号，覆盖 @ikenxuan/amagi 的全部公开导出（src/index.ts
的导出面）。每个符号的签名、参数表与源码位置在它自己那一页；同一批能力的
HTTP 形态见 HTTP 端点参考，SDK 形态见
各平台 SDK 方法页。
函数
类、枚举与变量
| 符号 | 种类 | 说明 |
|---|---|---|
AdditionalType | 枚举 | 相关内容卡片类型枚举 用于标识动态中附加的相关内容卡片的类型 |
amagi | 变量 | |
AMAGI_BUS_EVENT_NAMES | 变量 | 全部事件名（12 个与 v6 对齐 + 3 个会话事件），用于遍历与穷尽性校验。 与 [AmagiBusEventMap](/docs/v7/usage/api/types/… |
amagiEvents | 变量 | Amagi 全局事件发射器实例 |
AmagiThrownError | 类 | unwrap 失败时抛出的 Error 子类。 为什么不直接 … |
ApiError | 类 | API错误类 |
BILIBILI_CORRESPOND_PUBKEY | 变量 | B站 correspondPath 的 RSA 公钥（1024bit）。 删库前官方文档公开的明文公钥，多来源字节一致。correspondPath = 用它 RSA-OAEP-… |
bilibiliApiUrls | 变量 | B站 URL 构造器（v6 实现）。v7 门面（client.bilibili）上的是 apiUrls（v7 那份，在 … |
bilibiliFetcher | 变量 | B站数据获取器（静态）。 包含所有 B站 API 方法，调用时需要传递 cookie |
bilibiliUtils | 变量 | B站相关功能模块 (工具集) |
createAmagiClient | 变量 | 创建Amagi客户端实例 |
CreateApp | 变量 | After instantiation, it can interact with the specified platform API to quickly obtain dat… |
default | 变量 | After instantiation, it can interact with the specified platform API to quickly obtain dat… |
douyinApiUrls | 变量 | 抖音 URL 构造器（v6 实现）。v7 门面（client.douyin）上的是 apiUrls（v7 那份，在 platforms/douyin/api.ts）；这… |
douyinFetcher | 变量 | 抖音数据获取器（静态）。 包含所有抖音 API 方法，调用时需要传递 cookie |
douyinPassport | 命名空间 | 抖音 passport 扫码登录协议实现 login.douyin.com 的接口与 www.douyin.com 的数据接口是两套体系： - query 需要 p_no /… |
douyinSign | 类 | |
douyinUtils | 变量 | 抖音相关功能模块 (工具集) |
DynamicType | 枚举 | 动态类型枚举 独立成叶子模块：Dynamic 子树各叶子类型文件都要用它做判别字段， 若定义在 DynamicInfo/index.ts 会形成叶子反向导入 barrel 的… |
KUAISHOU_H5_CAPTCHA_RESULT | 变量 | H5 REST 的风控业务码 |
KUAISHOU_PC_CAPTCHA_RESULT | 变量 | PC GraphQL 的风控业务码 |
kuaishouApiUrls | 变量 | 快手 URL 构造器（v6 实现）。v7 门面（client.kuaishou）上的是 apiUrls（v7 那份，在 … |
kuaishouFetcher | 变量 | 快手数据获取器（静态）。 包含所有快手 API 方法，调用时需要传递 cookie |
kuaishouSign | 类 | 快手签名工具集。 负责将请求描述对象转换为带 __NS_hxfalcon / kww 的最终请求材料。 |
kuaishouUtils | 变量 | 快手相关功能模块 (工具集) |
MajorType | 枚举 | 转发动态种子动态主体类型枚举 |
ValidationError | 类 | 参数验证错误类 |
XIAOHONGSHU_ANTI_SPAM_STATUS | 变量 | 反垃圾状态码。平台 redcaptcha SDK 里的名字是 antiSpam |
XIAOHONGSHU_ANTI_SPIDER_STATUS | 变量 | 反爬状态码。平台 redcaptcha SDK 里的名字是 antiSpider |
xiaohongshuApiUrls | 变量 | 小红书 URL 构造器（v6 实现）。v7 门面（client.xiaohongshu）上的是 apiUrls（v7 那份，在 … |
xiaohongshuFetcher | 变量 | 小红书数据获取器（静态）。 包含所有小红书 API 方法，调用时需要传递 cookie |
xiaohongshuSign | 类 | 小红书签名算法类 |
xiaohongshuUtils | 变量 | 小红书相关功能模块 (工具集) |
接口
| 符号 | 种类 | 说明 |
|---|---|---|
AmagiAxiosTrack | 接口 | axios 轨。 与信封轨共用同一个实例、同一套 defaults / interceptors —— 差别只有一处： 失败的判据是「信封是不是失败信封」时，这里**抛*… |
AmagiBusEventMap | 接口 | 事件名 → 负载的映射（实例级总线用；顶层导出的 AmagiEventMap 描述的是 全局单例 amagiEvents，是另一张表）。 名字不与 … |
AmagiError | 接口 | 失败信封里唯一的错误载体，永不为 undefined |
AmagiEventMap | 接口 | 事件类型到数据的映射 |
AmagiFailure | 接口 | 失败信封 |
AmagiMeta | 接口 | 挂在每个信封上的元信息 |
AmagiRequest | 接口 | 平台的请求模块。 打的是任何 URL（包括 amagi 还没收录的接口），自动带上实例 ck 与平台签名， 走与 fetcher 同一条 execute 管线与同一套… |
AmagiRequestConfig | 接口 | client.<平台>.request 的入参。 在 axios 配置之上做两处收窄，都是为了让「不可能发生的事」编译不过： - 去掉 adapter —— 传它… |
AmagiRequestOptions | 接口 | 单次请求的 amagi 专属选项。 挂在 axios 配置的 amagi 键下（… |
AmagiSuccess | 接口 | 成功信封 |
ApiErrorEventData | 接口 | API 错误事件数据 |
ApiSuccessEventData | 接口 | API 成功事件数据 |
BilibiliFetcher | 接口 | B站 Fetcher 类型（静态形态：三参签名）。 写成 interface … extends 而不是 type … =：后者是泛型类型别名， 打印器（IDE … |
BilibiliMethodOptionsMap | 接口 | B站 API 方法参数映射接口 每个键对应一种 API 方法，值为该方法所需的参数接口 |
BilibiliRefreshInput | 接口 | 刷新入参 |
BilibiliRefreshOutput | 接口 | 刷新产物 |
BilibiliReturnTypeMap | 接口 | B站返回类型映射 将 methodType 映射到对应的返回数据类型 |
BoundBilibiliFetcher | 接口 | 绑定 Cookie 的B站 Fetcher 类型（两参签名：cookie 已绑，只剩 options / requestConfig）。 名义接口，理由同 [… |
BoundDouyinFetcher | 接口 | 绑定 Cookie 的抖音 Fetcher 类型（形状 = FetcherOf，两参签名）。 名义接口，理由同 [DouyinStaticFetcher](/docs/v… |
BoundKuaishouFetcher | 接口 | 绑定 Cookie 的快手 Fetcher 类型（两参签名：cookie 已绑，只剩 options / requestConfig）。 名义接口，理由同 [… |
BoundXiaohongshuFetcher | 接口 | 绑定 Cookie 的小红书 Fetcher 类型（两参签名：cookie 已绑，只剩 options / requestConfig）。 名义接口，理由同 [… |
CaptchaChallenge | 接口 | 图形验证码 challenge |
CheckDouyinLoginStateOptions | 接口 | |
ClientOptions | 接口 | 客户端构造选项 |
Credential | 接口 | 跨平台统一的登录凭证 |
DouyinCredentialRequestOptions | 接口 | 凭据请求与 API 请求走同一套 transport/代理/adapter。 |
DouyinFetcher | 接口 | 抖音 Fetcher 类型（静态形态：三参签名 + 4 个 passport 方法）。 名义接口，理由同 [DouyinStaticFetcher](/docs/v7/usa… |
DouyinLoginCheck | 接口 | |
DouyinMethodOptionsMap | 接口 | 抖音 API 方法参数映射接口 每个键对应一种 API 方法，值为该方法所需的参数接口 |
DouyinReturnTypeMap | 接口 | 抖音返回类型映射 将 methodType 映射到对应的返回数据类型 |
DouyinStaticFetcher | 接口 | 抖音静态 fetcher 的类型（不含 passport，纯 registry 派生形态）。 写成 interface … extends 而不是 … |
DyPassportQrcode | 接口 | 登录二维码 |
DyPassportSendCodeResult | 接口 | 发码接口归一化后的结果，不含会话字段 |
DyPassportValidateCodeResult | 接口 | 验码接口归一化后的结果，不含会话字段 |
DyPassportVerifyContext | 接口 | 二次验证上下文 字段全部来自轮询响应，需原样透传给发码与验码接口，缺字段会被判为伪造请求。 |
DyPassportVerifyWay | 接口 | 二次验证的一种可选方式 |
EventBus | 接口 | 类型安全的事件总线。 一个 client 实例一条。构造两条就是两条，彼此不共享监听器。 |
FacadeServerOptions | 接口 | 门面版 startServer 的第二参。 只透出 openapi 一项；port / host / token / routers 这些全选项留给 … |
HttpRequestEventData | 接口 | HTTP 请求事件数据 |
HttpResponseEventData | 接口 | HTTP 响应事件数据 |
KuaishouCaptchaChallenge | 接口 | 交给调用方的风控挑战 |
KuaishouFetcher | 接口 | 快手 Fetcher 类型（静态形态：三参签名）。 写成 interface … extends 而不是 type … =：后者是泛型类型别名， 打印器（IDE … |
KuaishouMethodOptionsMap | 接口 | 快手 API 方法参数映射 |
KuaishouReturnTypeMap | 接口 | 快手返回类型映射 |
LogEventData | 接口 | 日志事件数据 |
LoginNamespace | 接口 | 登录命名空间：qrcode() 创建会话，resume() 从 opaque string 恢复 |
LoginSession | 接口 | 登录会话：三种消费方式（回调 / AsyncIterable / 手动单步）。 返回终态时永不 reject（除调用方回调自己抛出）。 |
MintDouyinGuestCookieOptions | 接口 | |
NetworkErrorEventData | 接口 | 网络错误事件数据 |
NetworkRetryEventData | 接口 | 网络重试事件数据 |
NormalizedDouyinCookie | 接口 | |
Qrcode | 接口 | 二维码 |
QrcodeLoginStrategy | 接口 | 平台扫码登录策略。 轮询循环 / 超时 / 退避 / 取消全在引擎里，策略只写协议细节。 |
RequestTrace | 接口 | 单次底层 HTTP 请求的明细 |
ResolvedDouyinCredential | 接口 | |
ResolveDouyinCredentialOptions | 接口 | |
RiskChallenge | 接口 | 风控挑战：撞验证页时交给调用方的「怎么过去」。 为什么不塞进 JudgeVerdict：judge 只管分类，四个槽位装不下一个 URL。但 … |
SessionCtx | 接口 | 平台会话上下文。 由引擎创建并逐次轮询更新；平台私有字段（biz_trace_id / verify_way / verifyTicket / encryptUid / stdP… |
SmsChallenge | 接口 | 短信验证码 challenge |
SuccessBilibiliFetcher | 接口 | 只保留成功分支的B站 fetcher 类型。 给「用一层 Proxy 把失败信封转成异常」的下游封装用：包装后的 fetcher 声明成 这个类型，.data 就是 T … |
SuccessDouyinFetcher | 接口 | 只保留成功分支的抖音 fetcher 类型。 给「用一层 Proxy 把失败信封转成异常」的下游封装用：包装后的 fetcher 声明成 这个类型，.data 就是 T … |
SuccessKuaishouFetcher | 接口 | 只保留成功分支的快手 fetcher 类型。 给「用一层 Proxy 把失败信封转成异常」的下游封装用：包装后的 fetcher 声明成 这个类型，.data 就是 T … |
SuccessXiaohongshuFetcher | 接口 | 只保留成功分支的小红书 fetcher 类型。 给「用一层 Proxy 把失败信封转成异常」的下游封装用：包装后的 fetcher 声明成 这个类型，.data 就是 T… |
ValidationIssue | 接口 | kind === 'validation' 时的字段级错误 |
VerifyPageOptions | 接口 | renderVerifyPage 的选项 |
WatchHandlers | 接口 | 会话回调（watch 出口） |
WatchOptions | 接口 | 会话 watch 选项 |
XiaohongshuFetcher | 接口 | 小红书 Fetcher 类型（静态形态：三参签名）。 写成 interface … extends 而不是 type … =：后者是泛型类型别名， 打印器（IDE… |
XiaohongshuMethodOptionsMap | 接口 | 小红书 API 方法参数映射 |
XiaohongshuReturnTypeMap | 接口 | 小红书返回类型映射 |
XiaohongshuSessionInput | 接口 | 小红书同一会话的 Cookie 与可选签名材料；不属于 HTTP 请求配置。 |
核心类型
| 符号 | 种类 | 说明 |
|---|---|---|
AmagiBusEventName | 类型别名 | 事件名 |
AmagiErrorCode | 类型别名 | 稳定的字符串错误码，可用于 switch 与埋点。 用字符串字面量联合而不是 enum：enum 的 Object.values() 会带出反向映射键， 且拿平台… |
AmagiEventType | 类型别名 | Amagi 支持的事件类型 |
AmagiRequestMethod | 类型别名 | 单次调用（信封轨） |
AmagiResult | 类型别名 | 所有对外 API 的唯一返回类型 |
BilibiliMethodType | 类型别名 | B站方法类型 |
ChallengeAnswer | 类型别名 | 按 challenge 的 kind 决定应答的形状。 条件类型是「回调返回错字段编译期报错」的落点： c.kind === 'sms' 收窄后 C 推断为 … |
CommentType | 类型别名 | B站评论区类型代码（comments / commentReplies 的 type 参数）。 完整对照表（部分 oid 含义官方未明确，转写自 bilibili-A… |
CookieConfig | 类型别名 | Cookie配置选项接口 |
DouyinCredentialOrigin | 类型别名 | 这份凭据是怎么来的。 guest-minted 与 guest-device 的分界是有没有拿到访客 id，不是「握手有没有出货」： 服务端把「挑战过没过」与「发… |
DouyinLoginState | 类型别名 | |
DouyinMethodType | 类型别名 | 抖音方法类型 |
DouyinUifidSource | 类型别名 | |
ErrorKind | 类型别名 | 跨平台统一的错误大类，也是调用方唯一需要 switch 的判别键。 粗粒度归因用 kind，细粒度归因用 [AmagiErrorCode](/docs/v7/usag… |
KuaishouGraphqlRequest | 类型别名 | 快手 GraphQL 请求描述对象。 该结构只负责描述请求，不负责执行网络请求。 |
KuaishouLiveApiRequest | 类型别名 | 快手 live_api 请求描述对象。 除了最终请求地址外，还可以携带 signPath，用于声明 __NS_hxfalcon 实际参与签名的规范路径。 |
KuaishouMethodType | 类型别名 | |
LoginChallenge | 类型别名 | 二次验证 challenge |
LoginState | 类型别名 | 登录会话的状态。判别键是 phase |
Options | 类型别名 | 客户端配置选项接口 形状冻结不动。ClientOptions 是它的超集（多一个 debug）， 两者赋值互通，所以 … |
Platform | 类型别名 | amagi 支持的平台 |
RequestConfig | 类型别名 | 请求配置选项接口 与 contracts/request.ts 的同名类型逐字相同（顶层导出的就是 contracts 那一份）。新代码请用 contracts 的。 |
TraceReason | 类型别名 | 一次底层请求的发起原因。 区分「端点内重试」与「传输层重试」、「翻页」与「分段并发」， 是排查请求数叠乘的入口。 |
VerifyPlatform | 类型别名 | 有风控 challenge 的平台（B 站没有 challenge 提取器） |