Skip to content

zentao-api / GlobalOptions

Interface: GlobalOptions ​

SDK 进程级全局默认选项,供高阶 request 调用复用。

Properties ​

PropertyTypeDescription
autoFill?boolean是否在执行 update 操作时自动填充未传入的字段,默认 false。 优先级低于单次请求选项;语义见 RequestOptions.autoFill。
client?ZentaoClient默认客户端;通常由 ZentaoClient.init() 设置。
insecure?boolean默认 TLS 跳过证书验证选项;仅 Node.js 运行时支持。
limit?string默认限制返回列表数量,只影响 SDK 归一化后的 data。
persistProfiles?boolean是否在登录成功后把账号、Token 和配置持久化为本地 profile。
recPerPage?string默认每页记录数,会映射到模块动作的 recPerPage 参数。
skipVersionCheckOnConfigError?boolean配置网络或响应获取失败时,允许登录继续或高阶请求跳过版本检查,默认 false;不忽略版本不匹配、格式错误或存储错误。
throwOnFail?boolean当禅道服务端返回 { status: "fail" } 时是否抛出 E_API_FAILED,默认 false。
timeout?number默认请求超时时间,优先级低于单次请求选项。
version?string当前禅道正式版本,例如 biz13.5;普通高阶请求直接使用,单次强制刷新时使用实际版本。不会自动写入 profile。

Released under the MIT License.