Skip to content

Commit f5bec10

Browse files
committed
refactor: 优化资源重试插件的配置代码格式
调整zod验证器的代码格式以提高可读性,包括数组和对象的换行对齐。保持功能不变,仅改进代码风格。
1 parent 2b7b9f2 commit f5bec10

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

src/index.ts

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -79,46 +79,64 @@ export default (api: IApi) => {
7979
domain: zod
8080
.union([
8181
zod.array(zod.string()),
82-
zod.record(zod.string(), zod.string())
82+
zod.record(zod.string(), zod.string()),
8383
])
84-
.describe('域名配置列表。可以是字符串数组(如 ["cdn1.example.com", "cdn2.example.com"])或域名映射对象(如 {"old.com": "new.com"})。只有在此列表中的域名资源才会在加载失败时进行重试。空数组表示所有域名都不重试。')
84+
.describe(
85+
'域名配置列表。可以是字符串数组(如 ["cdn1.example.com", "cdn2.example.com"])或域名映射对象(如 {"old.com": "new.com"})。只有在此列表中的域名资源才会在加载失败时进行重试。空数组表示所有域名都不重试。',
86+
)
8587
.default([])
8688
.optional(),
8789
maxRetryCount: zod
8890
.number()
8991
.int()
9092
.min(0)
9193
.max(10)
92-
.describe('单个资源的最大重试次数。当资源加载失败时,系统会根据此配置进行重试。设置为 0 表示不重试,建议值为 1-5 次。过高的重试次数可能影响页面加载性能。')
94+
.describe(
95+
'单个资源的最大重试次数。当资源加载失败时,系统会根据此配置进行重试。设置为 0 表示不重试,建议值为 1-5 次。过高的重试次数可能影响页面加载性能。',
96+
)
9397
.default(3)
9498
.optional(),
9599
onRetry: zod
96100
.function()
97-
.args(zod.string(), zod.string(), zod.nullable(zod.object({
98-
retryTimes: zod.number(),
99-
succeeded: zod.array(zod.string()),
100-
failed: zod.array(zod.string())
101-
})))
101+
.args(
102+
zod.string(),
103+
zod.string(),
104+
zod.nullable(
105+
zod.object({
106+
retryTimes: zod.number(),
107+
succeeded: zod.array(zod.string()),
108+
failed: zod.array(zod.string()),
109+
}),
110+
),
111+
)
102112
.returns(zod.union([zod.string(), zod.null()]))
103-
.describe('资源重试时的自定义处理函数。接收参数:currentUrl(当前重试的URL)、originalUrl(原始URL)、retryCollector(重试统计信息对象,包含重试次数和成功/失败记录)。返回新的重试URL字符串或null(表示不重试)。可用于实现域名切换、URL修改等自定义重试逻辑。')
113+
.describe(
114+
'资源重试时的自定义处理函数。接收参数:currentUrl(当前重试的URL)、originalUrl(原始URL)、retryCollector(重试统计信息对象,包含重试次数和成功/失败记录)。返回新的重试URL字符串或null(表示不重试)。可用于实现域名切换、URL修改等自定义重试逻辑。',
115+
)
104116
.optional(),
105117
onSuccess: zod
106118
.function()
107119
.args(zod.string())
108120
.returns(zod.void())
109-
.describe('资源成功加载时的回调函数。接收参数:currentUrl(成功加载的资源URL)。可用于统计成功加载的资源、发送监控数据、更新UI状态等。注意:CSS中的背景图片资源不会触发此回调。')
121+
.describe(
122+
'资源成功加载时的回调函数。接收参数:currentUrl(成功加载的资源URL)。可用于统计成功加载的资源、发送监控数据、更新UI状态等。注意:CSS中的背景图片资源不会触发此回调。',
123+
)
110124
.optional(),
111125
onFail: zod
112126
.function()
113127
.args(zod.string())
114128
.returns(zod.void())
115-
.describe('资源加载最终失败时的回调函数(已达到最大重试次数仍然失败)。接收参数:currentUrl(失败的资源URL)。可用于错误上报、降级处理、用户提示等。注意:CSS中的背景图片资源不会触发此回调。')
116-
.optional()
129+
.describe(
130+
'资源加载最终失败时的回调函数(已达到最大重试次数仍然失败)。接收参数:currentUrl(失败的资源URL)。可用于错误上报、降级处理、用户提示等。注意:CSS中的背景图片资源不会触发此回调。',
131+
)
132+
.optional(),
117133
})
118-
.describe('资源加载失败重试插件配置。基于 assets-retry 库,提供前端静态资源(JS、CSS、图片等)加载失败时的自动重试机制,支持多域名切换、自定义重试逻辑和状态监控,提升应用在网络不稳定环境下的可用性。')
134+
.describe(
135+
'资源加载失败重试插件配置。基于 assets-retry 库,提供前端静态资源(JS、CSS、图片等)加载失败时的自动重试机制,支持多域名切换、自定义重试逻辑和状态监控,提升应用在网络不稳定环境下的可用性。',
136+
)
119137
.optional()
120138
.default({});
121-
}
139+
},
122140
},
123141
enableBy: api.EnableBy.config,
124142
});

0 commit comments

Comments
 (0)