diff --git a/README.md b/README.md index 14f5133..feafad4 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,6 @@ import "github.com/duke-git/lancet/v2/condition" [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition.md#TernaryOperator)] [[play](https://go.dev/play/p/ElllPZY0guT)] - ### 4. Convertor package contains some functions for data convertion. ```go @@ -187,6 +186,7 @@ import "github.com/duke-git/lancet/v2/convertor" ``` #### Function list: + - **ColorHexToRGB** : convert color hex to color rgb. [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorHexToRGB)] [[play](https://go.dev/play/p/o7_ft-JCJBV)] @@ -236,7 +236,6 @@ import "github.com/duke-git/lancet/v2/convertor" [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#DecodeByte)] [[play](https://go.dev/play/p/zI6xsmuQRbn)] - ### 5. Cryptor package is for data encryption and decryption. ```go @@ -349,21 +348,51 @@ import "github.com/duke-git/lancet/v2/fileutil" #### Function list: -- [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ClearFile) -- [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateFile) -- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateDir) -- [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CopyFile) -- [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileMode) -- [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MiMeType) -- [IsExist](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsExist) -- [IsLink](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsLink) -- [IsDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsDir) -- [ListFileNames](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ListFileNames) -- [RemoveFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#RemoveFile) -- [ReadFileToString](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileToString) -- [ReadFileByLine](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileByLine) -- [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip) -- [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip) +- **ClearFile** : write empty string to target file. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ClearFile)] + [[play](https://go.dev/play/p/NRZ0ZT-G94H)] +- **CreateFile** : create file in path. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateFile)] + [[play](https://go.dev/play/p/lDt8PEsTNKI)] +- **CreateDir** : create directory in absolute path. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateDir)] + [[play](https://go.dev/play/p/qUuCe1OGQnM)] +- **CopyFile** :copy src file to dest file. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CopyFile)] + [[play](https://go.dev/play/p/Jg9AMJMLrJi)] +- **FileMode** : return file's mode and permission. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileMode)] + [[play](https://go.dev/play/p/2l2hI42fA3p)] +- **MiMeType** : return file mime type. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MiMeType)] + [[play](https://go.dev/play/p/bd5sevSUZNu)] +- **IsExist** : checks if a file or directory exists. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsExist)] + [[play](https://go.dev/play/p/nKKXt8ZQbmh)] +- **IsLink** : checks if a file is symbol link or not. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsLink)] + [[play](https://go.dev/play/p/TL-b-Kzvf44)] +- **IsDir** : checks if the path is directory or not. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsDir)] + [[play](https://go.dev/play/p/WkVwEKqtOWk)] +- **ListFileNames** : return all file names in the path. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ListFileNames)] + [[play](https://go.dev/play/p/Tjd7Y07rejl)] +- **RemoveFile** : remove file, param should be file path. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#RemoveFile)] + [[play](https://go.dev/play/p/P2y0XW8a1SH)] +- **ReadFileToString** : return string of file content. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileToString)] + [[play](https://go.dev/play/p/cmfwp_5SQTp)] +- **ReadFileByLine** : read file line by line, return string slice of file content. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileByLine)] + [[play](https://go.dev/play/p/svJP_7ZrBrD)] +- **Zip** : create zip file. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip)] + [[play](https://go.dev/play/p/j-3sWBp8ik_P)] +- **UnZip** : unzip the zip file and save it to dest path. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip)] + [[play](https://go.dev/play/p/g0w34kS7B8m)] ### 9. Formatter contains some functions for data formatting. @@ -377,7 +406,6 @@ import "github.com/duke-git/lancet/v2/formatter" [[doc](https://github.com/duke-git/lancet/blob/main/docs/formatter.md#Comma)] [[play](https://go.dev/play/p/eRD5k2vzUVX)] - ### 10. Function package can control the flow of function execution and support part of functional programming ```go @@ -428,7 +456,6 @@ import "github.com/duke-git/lancet/v2/maputil" [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil.md#IsDisjoint)] [[play](https://go.dev/play/p/N9qgYg_Ho6f)] - ### 12. Mathutil package implements some functions for math calculation. ```go @@ -473,7 +500,6 @@ import "github.com/duke-git/lancet/v2/mathutil" [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound)] [[play](https://go.dev/play/p/aumarSHIGzP)] - ### 13. Netutil package contains functions to get net information and send http request. ```go diff --git a/README_zh-CN.md b/README_zh-CN.md index 2c86800..1f2aa73 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -130,19 +130,19 @@ import "github.com/duke-git/lancet/v2/concurrency" [[doc](https://github.com/duke-git/lancet/blob/main/docs/Bridge.md#NewChannel)] - **FanIn** : 将多个 channel 合并为一个 channel,直到取消上下文。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#FanIn)] -- **Generate** : 根据传入的值,生成channel。 +- **Generate** : 根据传入的值,生成 channel。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Generate)] -- **Or** : 将一个或多个channel读取到一个channel中,当任何读取channel关闭时将结束读取。 +- **Or** : 将一个或多个 channel 读取到一个 channel 中,当任何读取 channel 关闭时将结束读取。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Or)] -- **OrDone** : 将一个channel读入另一个channel,直到取消上下文。 +- **OrDone** : 将一个 channel 读入另一个 channel,直到取消上下文。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#OrDone)] -- **Repeat** : 返回一个channel,将参数`values`重复放入channel,直到取消上下文。 +- **Repeat** : 返回一个 channel,将参数`values`重复放入 channel,直到取消上下文。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Repeat)] -- **RepeatFn** : 返回一个channel,重复执行函数fn,并将结果放入返回的channel,直到取消上下文。 +- **RepeatFn** : 返回一个 channel,重复执行函数 fn,并将结果放入返回的 channel,直到取消上下文。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#RepeatFn)] -- **Take** : 返回一个channel,其值从另一个channel获取,直到取消上下文。 +- **Take** : 返回一个 channel,其值从另一个 channel 获取,直到取消上下文。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Take)] -- **Tee** : 将一个channel分成两个channel,直到取消上下文。 +- **Tee** : 将一个 channel 分成两个 channel,直到取消上下文。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Tee)] ### 3. condition 包含一些用于条件判断的函数。 @@ -152,32 +152,32 @@ import "github.com/duke-git/lancet/v2/condition" ``` #### Function list: -- **Bool** : 返回传入参数的bool值。 + +- **Bool** : 返回传入参数的 bool 值。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Bool)] [[play](https://go.dev/play/p/ETzeDJRSvhm)] -- **And** : 逻辑且操作,当切仅当a和b都为true时返回true。 +- **And** : 逻辑且操作,当切仅当 a 和 b 都为 true 时返回 true。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#And)] [[play](https://go.dev/play/p/W1SSUmt6pvr)] -- **Or** : 逻辑或操作,当切仅当a和b都为false时返回false。 +- **Or** : 逻辑或操作,当切仅当 a 和 b 都为 false 时返回 false。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Or)] [[play](https://go.dev/play/p/UlQTxHaeEkq)] -- **Xor** : 逻辑异或操作,a和b相同返回false,a和b不相同返回true +- **Xor** : 逻辑异或操作,a 和 b 相同返回 false,a 和 b 不相同返回 true [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Xor)] [[play](https://go.dev/play/p/gObZrW7ZbG8)] - **Nor** : 异或的取反操作。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Nor)] [[play](https://go.dev/play/p/g2j08F_zZky) -- **Xnor** : 如果a和b都是真的或a和b均是假的,则返回true。 +- **Xnor** : 如果 a 和 b 都是真的或 a 和 b 均是假的,则返回 true。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Xnor)] [[play](https://go.dev/play/p/OuDB9g51643)] -- **Nand** : 如果a和b都为真,返回false,否则返回true +- **Nand** : 如果 a 和 b 都为真,返回 false,否则返回 true [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Nand)] [[play](https://go.dev/play/p/vSRMLxLIbq8)] - **TernaryOperator** : 三元运算符。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#TernaryOperator)] [[play](https://go.dev/play/p/ElllPZY0guT)] - ### 4. convertor 转换器包支持一些常见的数据类型转换。 ```go @@ -185,34 +185,35 @@ import "github.com/duke-git/lancet/v2/convertor" ``` #### 函数列表: -- **ColorHexToRGB** : 颜色值十六进制转rgb。 + +- **ColorHexToRGB** : 颜色值十六进制转 rgb。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorHexToRGB)] [[play](https://go.dev/play/p/o7_ft-JCJBV)] -- **ColorRGBToHex** : 颜色值rgb转十六进制。 +- **ColorRGBToHex** : 颜色值 rgb 转十六进制。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorRGBToHex)] [[play](https://go.dev/play/p/nzKS2Ro87J1)] -- **ToBool** : 字符串转布尔类型,使用strconv.ParseBool。 +- **ToBool** : 字符串转布尔类型,使用 strconv.ParseBool。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBool)] [[play](https://go.dev/play/p/ARht2WnGdIN)] -- **ToBytes** : interface转字节切片。 +- **ToBytes** : interface 转字节切片。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBytes)] [[play](https://go.dev/play/p/fAMXYFDvOvr)] - **ToChar** : 字符串转字符切片。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChar)] [[play](https://go.dev/play/p/JJ1SvbFkVdM)] -- **ToChannel** : 将切片转为只读channel。 +- **ToChannel** : 将切片转为只读 channel。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChannel)] [[play](https://go.dev/play/p/hOx_oYZbAnL)] -- **ToFloat** : 将interface转成float64类型,如果参数无法转换,会返回0.0和error。 +- **ToFloat** : 将 interface 转成 float64 类型,如果参数无法转换,会返回 0.0 和 error。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToFloat)] [[play](https://go.dev/play/p/4YTmPCibqHJ)] -- **ToInt** : 将interface转成int64类型,如果参数无法转换,会返回0和error。 +- **ToInt** : 将 interface 转成 int64 类型,如果参数无法转换,会返回 0 和 error。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToInt)] [[play](https://go.dev/play/p/9_h9vIt-QZ_b)] -- **ToJson** : 将interface转成json字符串,如果参数无法转换,会返回""和error。 +- **ToJson** : 将 interface 转成 json 字符串,如果参数无法转换,会返回""和 error。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToJson)] [[play](https://go.dev/play/p/2rLIkMmXWvR)] -- **ToMap** : 将切片转为map。 +- **ToMap** : 将切片转为 map。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToMap)] [[play](https://go.dev/play/p/tVFy7E-t24l)] - **ToPointer** : 返回传入值的指针。 @@ -221,19 +222,18 @@ import "github.com/duke-git/lancet/v2/convertor" - **ToString** : 将值转换为字符串,对于数字、字符串、[]byte,将转换为字符串。 对于其他类型(切片、映射、数组、结构)将调用 json.Marshal。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToString)] [[play](https://go.dev/play/p/nF1zOOslpQq)] -- **StructToMap** : 将struct转成map,只会转换struct中可导出的字段。 +- **StructToMap** : 将 struct 转成 map,只会转换 struct 中可导出的字段。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#StructToMap)] [[play](https://go.dev/play/p/KYGYJqNUBOI)] -- **MapToSlice** : map中key和value执行函数iteratee后,转为切片。 +- **MapToSlice** : map 中 key 和 value 执行函数 iteratee 后,转为切片。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#MapToSlice)] [[play](https://go.dev/play/p/dmX4Ix5V6Wl)] -- **EncodeByte** : 将传入的data编码成字节切片。 +- **EncodeByte** : 将传入的 data 编码成字节切片。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#EncodeByte)] [[play](https://go.dev/play/p/DVmM1G5JfuP)] - **DecodeByte** : 解码字节切片到目标对象,目标对象需要传入一个指针实例。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#DecodeByte)] [[play](https://go.dev/play/p/zI6xsmuQRbn)] - ### 5. cryptor 加密包支持数据加密和解密,获取 md5,hash 值。支持 base64, md5, hmac, aes, des, rsa。 @@ -347,21 +347,51 @@ import "github.com/duke-git/lancet/v2/fileutil" #### 函数列表: -- [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ClearFile) -- [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateFile) -- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateDir) -- [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CopyFile) -- [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#FileMode) -- [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#MiMeType) -- [IsExist](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsExist) -- [IsLink](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsLink) -- [IsDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsDir) -- [ListFileNames](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ListFileNames) -- [RemoveFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#RemoveFile) -- [ReadFileToString](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileToString) -- [ReadFileByLine](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileByLine) -- [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip) -- [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip) +- **ClearFile** : 清空文件内容。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ClearFile)] + [[play](https://go.dev/play/p/NRZ0ZT-G94H)] +- **CreateFile** : 创建文件,创建成功返回 true, 否则返回 false。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateFile)] + [[play](https://go.dev/play/p/lDt8PEsTNKI)] +- **CreateDir** : 创建嵌套目录,例如/a/, /a/b/。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateDir)] + [[play](https://go.dev/play/p/qUuCe1OGQnM)] +- **CopyFile** :拷贝文件,会覆盖原有的文件。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CopyFile)] + [[play](https://go.dev/play/p/Jg9AMJMLrJi)] +- **FileMode** : 获取文件 mode 信息。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#FileMode)] + [[play](https://go.dev/play/p/2l2hI42fA3p)] +- **MiMeType** : 获取文件 mime 类型, 参数的类型必须是 string 或者\*os.File。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#MiMeType)] + [[play](https://go.dev/play/p/bd5sevSUZNu)] +- **IsExist** : 判断文件或目录是否存在。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsExist)] + [[play](https://go.dev/play/p/nKKXt8ZQbmh)] +- **IsLink** : 判断文件是否是符号链接。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsLink)] + [[play](https://go.dev/play/p/TL-b-Kzvf44)] +- **IsDir** : 判断参数是否是目录。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsDir)] + [[play](https://go.dev/play/p/WkVwEKqtOWk)] +- **ListFileNames** : 返回目录下所有文件名。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ListFileNames)] + [[play](https://go.dev/play/p/Tjd7Y07rejl)] +- **RemoveFile** : 删除文件。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#RemoveFile)] + [[play](https://go.dev/play/p/P2y0XW8a1SH)] +- **ReadFileToString** : 读取文件内容并返回字符串。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileToString)] + [[play](https://go.dev/play/p/cmfwp_5SQTp)] +- **ReadFileByLine** : 按行读取文件内容,返回字符串切片包含每一行。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileByLine)] + [[play](https://go.dev/play/p/svJP_7ZrBrD)] +- **Zip** : zip 压缩文件, 参数可以是文件或目录。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip)] + [[play](https://go.dev/play/p/j-3sWBp8ik_P)] +- **UnZip** : zip 解压缩文件并保存在目录中。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip)] + [[play](https://go.dev/play/p/g0w34kS7B8m)] ### 9. formatter 格式化器包含一些数据格式化处理方法。 @@ -371,12 +401,10 @@ import "github.com/duke-git/lancet/v2/formatter" #### 函数列表: -- **Comma** : 用逗号每隔3位分割数字/字符串,支持前缀添加符号。 +- **Comma** : 用逗号每隔 3 位分割数字/字符串,支持前缀添加符号。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/formatter_zh-CN.md#Comma)] [[play](https://go.dev/play/p/eRD5k2vzUVX)] - - ### 10. function 函数包控制函数执行流程,包含部分函数式编程。 ```go @@ -402,31 +430,30 @@ import "github.com/duke-git/lancet/v2/maputil" #### 函数列表: -- **ForEach** : 对map中的每对key和value执行iteratee函数。 +- **ForEach** : 对 map 中的每对 key 和 value 执行 iteratee 函数。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#ForEach)] [[play](https://go.dev/play/p/OaThj6iNVXK)] -- **Filter** : 迭代map中的每对key和value,返回map,其中的key和value符合predicate函数。 +- **Filter** : 迭代 map 中的每对 key 和 value,返回 map,其中的 key 和 value 符合 predicate 函数。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#Filter)] [[play](https://go.dev/play/p/fSvF3wxuNG7)] -- **Intersect** : 多个map的交集操作。 +- **Intersect** : 多个 map 的交集操作。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#Intersect)] [[play](https://go.dev/play/p/Zld0oj3sjcC)] -- **Keys** : 返回map中所有key组成的切片。 +- **Keys** : 返回 map 中所有 key 组成的切片。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#Keys)] [[play](https://go.dev/play/p/xNB5bTb97Wd)] -- **Merge** : 合并多个map, 相同的key会被之后的key覆盖。 +- **Merge** : 合并多个 map, 相同的 key 会被之后的 key 覆盖。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#Merge)] [[play](https://go.dev/play/p/H95LENF1uB-)] -- **Minus** : 返回一个map,其中的key存在于mapA,不存在于mapB。 +- **Minus** : 返回一个 map,其中的 key 存在于 mapA,不存在于 mapB。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#Minus)] [[play](https://go.dev/play/p/3u5U9K7YZ9m)] -- **Values** : 返回map中所有values组成的切片 +- **Values** : 返回 map 中所有 values 组成的切片 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#Values)] [[play](https://go.dev/play/p/CBKdUc5FTW6)] -- **IsDisjoint** : 验证两个map是否具有不同的key。 +- **IsDisjoint** : 验证两个 map 是否具有不同的 key。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#IsDisjoint)] [[play](https://go.dev/play/p/N9qgYg_Ho6f)] - ### 12. mathutil 包实现了一些数学计算的函数。 @@ -436,13 +463,13 @@ import "github.com/duke-git/lancet/v2/mathutil" #### Function list: -- **Average** :计算平均数,可能需要对结果调用RoundToFloat方法四舍五入。 +- **Average** :计算平均数,可能需要对结果调用 RoundToFloat 方法四舍五入。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Average)] [[play](https://go.dev/play/p/Vv7LBwER-pz)] -- **Exponent** : 指数计算(x的n次方)。 +- **Exponent** : 指数计算(x 的 n 次方)。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Exponent)] [[play](https://go.dev/play/p/uF3HGNPk8wr)] -- **Fibonacci** :计算斐波那契数列的第n个数。 +- **Fibonacci** :计算斐波那契数列的第 n 个数。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Fibonacci)] [[play](https://go.dev/play/p/IscseUNMuUc)] - **Factorial** : 计算阶乘。 @@ -460,19 +487,18 @@ import "github.com/duke-git/lancet/v2/mathutil" - **MinBy** : 使用给定的比较器函数返回切片的最小值。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#MinBy)] [[play](https://go.dev/play/p/N9qgYg_Ho6f)] -- **Percent** : 计算百分比,可以指定保留n位小数。 +- **Percent** : 计算百分比,可以指定保留 n 位小数。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Percent)] -- **RoundToFloat** : 四舍五入,保留n位小数,返回float64。 +- **RoundToFloat** : 四舍五入,保留 n 位小数,返回 float64。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToFloat)] [[play](https://go.dev/play/p/ghyb528JRJL)] -- **RoundToString** : 四舍五入,保留n位小数,返回string。 +- **RoundToString** : 四舍五入,保留 n 位小数,返回 string。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToString)] [[play](https://go.dev/play/p/kZwpBRAcllO)] -- **TruncRound** : 截短n位小数(不进行四舍五入)。 +- **TruncRound** : 截短 n 位小数(不进行四舍五入)。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#TruncRound)] [[play](https://go.dev/play/p/aumarSHIGzP)] - ### 13. netutil 网络包支持获取 ip 地址,发送 http 请求。 ```go diff --git a/docs/fileutil_zh-CN.md b/docs/fileutil_zh-CN.md index 9bcf02d..39d04b4 100644 --- a/docs/fileutil_zh-CN.md +++ b/docs/fileutil_zh-CN.md @@ -119,7 +119,7 @@ func main() { ### CopyFile -
拷贝文件,会覆盖原有的拷贝文件
+拷贝文件,会覆盖原有的文件
函数签名: @@ -261,7 +261,7 @@ func main() { ### IsDir -判断目录是否存在
+判断参数是否是目录
函数签名: