Skip to content

Commit e36a78a

Browse files
authored
docs: update README.md
1 parent e299b77 commit e36a78a

File tree

1 file changed

+66
-1
lines changed

1 file changed

+66
-1
lines changed

README.md

+66-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,70 @@
22

33
用于批量处理资源。
44

5-
- transformImage 批量图片转换
5+
- transformImage 批量图片处理
66
- replaceFileContent 批量文件替换内容
7+
8+
### transformImage
9+
10+
批量图片处理
11+
12+
#### 参数
13+
14+
##### TransformImage
15+
16+
| 选项 | 类型 | 描述 |
17+
| --- | --- | --- |
18+
| entry | string | 图片入口目录 |
19+
| output | string | 图片出口目录 |
20+
| rules | Rule[] | 匹配图片规则 |
21+
| useFile | UseFile | 匹配被文件内用到的图片 |
22+
| mkdir | boolean | 是否创建文件夹 |
23+
| logFileGeneratePath | string | 日志文件存储路径 |
24+
| itemLog | boolean | 是否将每项的路径打印 |
25+
26+
##### Rule
27+
28+
| 选项 | 类型 | 描述 |
29+
| --- | --- | --- |
30+
| name | 'png' or 'jpg' | 匹配的图片格式 |
31+
| format | Format | 如何处理 |
32+
33+
#### Format
34+
35+
| 选项 | 类型 | 描述 |
36+
| --- | --- | --- |
37+
| name | 'webp' or 'svg' | 要转变的图片格式 |
38+
| max | number | 图片的最大体质 |
39+
| min | number | 图片的最小体积 |
40+
| handle | (info: { rawName: R, formatName: F, entryPath: string, outputPath: string, size: number }) => Promise<any> | 处理函数 |
41+
42+
#### UseFile
43+
44+
| 选项 | 类型 | 描述 |
45+
| --- | --- | --- |
46+
| dir | string | 文件入口目录 |
47+
| imageInFileAlias | Record<any, any> | 图片在文件内的别名 |
48+
49+
### replaceFileContent
50+
51+
批量文件替换内容
52+
53+
#### 参数
54+
55+
##### ReplaceFileContent
56+
57+
| 选项 | 类型 | 描述 |
58+
| --- | --- | --- |
59+
| entry | string | 文件入口目录 |
60+
| list | ReplaceInfo[] | 替换选项 |
61+
| logFileGeneratePath | string | 日志文件存储路径 |
62+
| itemLog | boolean | 是否将每项的路径打印 |
63+
64+
##### ReplaceInfo
65+
66+
| 选项 | 类型 | 描述 |
67+
| --- | --- | --- |
68+
| searchValue | string | 匹配值 |
69+
| replaceValue | List | 替换值 |
70+
71+

0 commit comments

Comments
 (0)