Skip to content

执行配置完整参考

执行配置 config 集中配置了请求层的所有控制点,在不同入口有不同的名字:

  • 模块函数 / invokeModule() 的第二个参数:ModuleCallConfig
  • createHanaMusicApi(config) 的参数:CreateHanaMusicApiConfig(在 ModuleCallConfig 基础上多了 cacheidentityPool
  • createRequest(uri, data, options) 的第三个参数:CreateRequestOptions(与 ModuleCallConfig 同构)

字段总表

字段类型默认值作用适用加密模式
cookiestring | CookieRecord{}登录态与身份。允许字符串和对象,请求层会自动补全设备号等字段。全部
crypto'' | 'api' | 'eapi' | 'weapi' | 'linuxapi'eapiencrypt 关时为 api选择上游通道与加解密方式。
ipstring运行时 cnIp伪装来源 IP,写入 X-Forwarded-For / X-Real-IP全部
realIPstringip,但优先级更高。两者都传时 realIP 生效。全部
proxystringHTTP 代理地址。不支持 PAC全部
uastring按加密模式选默认 UA覆盖 User-Agent全部
domainstringAPP_CONF 默认域名覆盖上游域名,用于自建反代等场景。全部
headersRecord<string, string>{}追加自定义请求头,会与内部生成的头合并。全部
fetcherFetchLike全局 fetch替换底层 HTTP 实现,用于注入代理 agent、拦截、测试桩。全部
timeoutMsnumber8000单次尝试的超时(毫秒)。传 0 或负数关闭超时。全部
retryRequestRetryOptions见重试文档重试策略:次数、退避、抖动、状态码白名单等。全部
connectionStrategy'default' | 'close' | 'fresh-on-retry''default'控制连接复用,应对长连接被上游悄悄断开的情况。全部
e_rboolean | number | stringfalse是否要求上游返回加密响应。eapi / weapi
acceptGzipbooleanfalse声明可接受 gzip 压缩的加密响应,省带宽。eapi
checkTokenboolean | number | stringfalse在 eapi header 注入反作弊 token。eapi / api
onRequestEvent(event: RequestDebugEvent) => void每次尝试 / 重试 / 失败的观测回调。全部
statePartial<RuntimeState>进程运行时状态按本次调用覆盖匿名 token / 伪装 IP / 设备号。全部

createHanaMusicApi 支持的字段

字段类型默认值作用
cache{ enabled?: boolean; ttlMs?: number }关闭开启内存响应缓存 + 并发去重(single-flight)。
identityPool{ size: number }关闭预注册多个匿名身份并按调用轮换。

详见 SDK 缓存与身份池

各字段的深入说明

Released under the MIT License.