doc: add document for GCD and LCM function

feat: add GCD and LCM function
feat: add IsLeapYear
2026-02-21 04:42:28 +08:00 · 2023-05-06 11:28:38 +08:00 · 2023-05-06 11:02:00 +08:00 · 2023-04-28 14:42:25 +08:00 · 2023-04-27 15:49:58 +08:00 · 2023-04-27 14:15:25 +08:00
29 changed files with 672 additions and 218 deletions
--- a/README.md
+++ b/README.md
@@ -128,16 +128,22 @@ import "github.com/duke-git/lancet/v2/compare"

 -   **<big>Equal</big>** : Checks if two values are equal or not. (check both type and value)
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare.md#Equal)]
+    [[play](https://go.dev/play/p/wmVxR-to4lz)]
 -   **<big>EqualValue</big>** : Checks if two values are equal or not. (check value only)
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare.md#EqualValue)]
+    [[play](https://go.dev/play/p/fxnna_LLD9u)]
 -   **<big>LessThan</big>** : Checks if value `left` less than value `right`.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare.md#LessThan)]
+    [[play](https://go.dev/play/p/cYh7FQQj0ne)]
 -   **<big>GreaterThan</big>** : Checks if value `left` greater than value `right`.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare.md#GreaterThan)]
+    [[play](https://go.dev/play/p/9-NYDFZmIMp)]
 -   **<big>LessOrEqual</big>** : Checks if value `left` less than or equal than value `right`.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare.md#LessOrEqual)]
+    [[play](https://go.dev/play/p/e4T_scwoQzp)]
 -   **<big>GreaterOrEqual</big>** : Checks if value `left` less greater or equal than value `right`.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare.md#GreaterOrEqual)]
+    [[play](https://go.dev/play/p/vx8mP0U8DFk)]

 ### 3. Concurrency package contain some functions to support concurrent programming. eg, goroutine, channel, async.

@@ -194,13 +200,13 @@ import "github.com/duke-git/lancet/v2/condition"
    [[play](https://go.dev/play/p/W1SSUmt6pvr)]
 -   **<big>Or</big>** : returns false if neither a nor b is truthy.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Or)]
-[[play](https://go.dev/play/p/UlQTxHaeEkq)]]
+[[play](https://go.dev/play/p/UlQTxHaeEkq)]
 -   **<big>Xor</big>** : returns true if a or b but not both is truthy.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Xor)]
    [[play](https://go.dev/play/p/gObZrW7ZbG8)]
 -   **<big>Nor</big>** : returns true if neither a nor b is truthy.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Nor)]
-    [[play](https://go.dev/play/p/g2j08F_zZky)
+    [[play](https://go.dev/play/p/g2j08F_zZky)]
 -   **<big>Xnor</big>** : returns true if both a and b or neither a nor b are truthy.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Xnor)]
    [[play](https://go.dev/play/p/OuDB9g51643)]
@@ -272,7 +278,7 @@ import "github.com/duke-git/lancet/v2/convertor"
    [[play](https://go.dev/play/p/j4DP5dquxnk)]
 -   **<big>CopyProperties</big>** : copies each field from the source struct into the destination struct.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#CopyProperties)]
-    [[play](https://go.dev/play/p/FOVY3XJL-6B)]
+    [[play](https://go.dev/play/p/oZujoB5Sgg5)]

 ### 6. Cryptor package is for data encryption and decryption.

@@ -567,14 +573,19 @@ import "github.com/duke-git/lancet/v2/fileutil"
    [[play](https://go.dev/play/p/s74a9iBGcSw)]
 -   **<big>IsZipFile</big>** : checks if file is zip file or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsZipFile)]
+    [[play](https://go.dev/play/p/9M0g2j_uF_e)]
 -   **<big>FileSize</big>** : return file size in bytes.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileSize)]
+    [[play](https://go.dev/play/p/H9Z05uD-Jjc)]
 -   **<big>MTime</big>** : return file modified time(unix timestamp).
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MTime)]
+    [[play](https://go.dev/play/p/s_Tl7lZoAaY)]
 -   **<big>Sha</big>** : return file sha value.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Sha)]
+    [[play](https://go.dev/play/p/VfEEcO2MJYf)]
 -   **<big>ReadCsvFile</big>** : read file content into slice.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadCsvFile)]
+    [[play](https://go.dev/play/p/OExTkhGEd3_u)]

 ### 10. Formatter contains some functions for data formatting.

@@ -845,8 +856,10 @@ import "github.com/duke-git/lancet/v2/netutil"
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#UploadFile)]
 -   **<big>IsPingConnected</big>** : checks if can ping the specified host or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsPingConnected)]
+    [[play](https://go.dev/play/p/q8OzTijsA87)]
 -   **<big>IsTelnetConnected</big>** : checks if can if can telnet the specified host or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsTelnetConnected)]
+    [[play](https://go.dev/play/p/yiLCGtQv_ZG)]

 ### 15. Random package implements some basic functions to generate random int and string.

@@ -984,11 +997,13 @@ import "github.com/duke-git/lancet/v2/slice"
    [[play](https://go.dev/play/p/CBKeBoHVLgq)]
 -   **<big>FindBy</big>** : iterates over elements of slice, returning the first one that passes a truth test on predicate function.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#FindBy)]
+    [[play](https://go.dev/play/p/n1lysBYl-GB)]
 -   **<big>FindLast<sup>deprecated</sup></big>** : return the last item that passes a truth test on predicate function.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#FindLast)]
    [[play](https://go.dev/play/p/FFDPV_j7URd)]
 -   **<big>FindLastBy</big>** : iterates over elements of slice, returning the last one that passes a truth test on predicate function.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#FindLastBy)]
+    [[play](https://go.dev/play/p/8iqomzyCl_s)]
 -   **<big>Flatten</big>** : flattens slice one level.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Flatten)]
    [[play](https://go.dev/play/p/hYa3cBEevtm)]
@@ -1314,16 +1329,22 @@ import "github.com/duke-git/lancet/v2/strutil"
    [[play](https://go.dev/play/p/og47F5x_jTZ)]
 -   **<big>StringToBytes</big>** : converts a string to byte slice without a memory allocation.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#StringToBytes)]
+    [[play](https://go.dev/play/p/7OyFBrf9AxA)]
 -   **<big>BytesToString</big>** : converts a byte slice to string without a memory allocation.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#BytesToString)]
+    [[play](https://go.dev/play/p/6c68HRvJecH)]
 -   **<big>IsBlank</big>** : checks if a string is whitespace or empty.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#IsBlank)]
+    [[play](https://go.dev/play/p/6zXRH_c0Qd3)]
 -   **<big>HasPrefixAny</big>** : checks if a string starts with any of an array of specified strings.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#HasPrefixAny)]
+    [[play](https://go.dev/play/p/8UUTl2C5slo)]
 -   **<big>HasSuffixAny</big>** : checks if a string ends with any of an array of specified strings.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#HasSuffixAny)]
+    [[play](https://go.dev/play/p/sKWpCQdOVkx)]
 -   **<big>IndexOffset</big>** : returns the index of the first instance of substr in string after offsetting the string by `idxFrom`.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#IndexOffset)]
+    [[play](https://go.dev/play/p/qZo4lV2fomB)]

 ### 21. System package contain some functions about os, runtime, shell command.

--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -127,16 +127,22 @@ import "github.com/duke-git/lancet/v2/compare"

 -   **<big>Equal</big>** : 检查两个值是否相等(检查类型和值)。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare_zh-CN.md#Equal)]
+    [[play](https://go.dev/play/p/wmVxR-to4lz)]
 -   **<big>EqualValue</big>** : 检查两个值是否相等(只检查值)。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare_zh-CN.md#EqualValue)]
+    [[play](https://go.dev/play/p/fxnna_LLD9u)]
 -   **<big>LessThan</big>** : 验证参数`left`的值是否小于参数`right`的值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare_zh-CN.md#LessThan)]
+    [[play](https://go.dev/play/p/cYh7FQQj0ne)]
 -   **<big>GreaterThan</big>** : 验证参数`left`的值是否大于参数`right`的值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare_zh-CN.md#GreaterThan)]
+    [[play](https://go.dev/play/p/9-NYDFZmIMp)]
 -   **<big>LessOrEqual</big>** : 验证参数`left`的值是否小于或等于参数`right`的值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare_zh-CN.md#LessOrEqual)]
+    [[play](https://go.dev/play/p/e4T_scwoQzp)]
 -   **<big>GreaterOrEqual</big>** : 验证参数`left`的值是否大于或等于参数`right`的值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/compare_zh-CN.md#GreaterOrEqual)]
+    [[play](https://go.dev/play/p/vx8mP0U8DFk)]

 ### 3. concurrency 包含一些支持并发编程的功能。例如：goroutine, channel, async 等。

@@ -199,10 +205,10 @@ import "github.com/duke-git/lancet/v2/condition"
    [[play](https://go.dev/play/p/gObZrW7ZbG8)]
 -   **<big>Nor</big>** : 异或的取反操作。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Nor)]
-    [[play](https://go.dev/play/p/g2j08F_zZky)
+    [[play](https://go.dev/play/p/g2j08F_zZky)]
 -   **<big>Xnor</big>** : 如果 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)]]
+[[play](https://go.dev/play/p/OuDB9g51643)]
 -   **<big>Nand</big>** : 如果 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)]
@@ -271,7 +277,7 @@ import "github.com/duke-git/lancet/v2/convertor"
    [[play](https://go.dev/play/p/j4DP5dquxnk)]
 -   **<big>CopyProperties</big>** : 拷贝不同结构体之间的同名字段。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#CopyProperties)]
-    [[play](https://go.dev/play/p/FOVY3XJL-6B)]
+    [[play](https://go.dev/play/p/oZujoB5Sgg5)]

 ### 6. cryptor 加密包支持数据加密和解密，获取 md5，hash 值。支持 base64, md5, hmac, aes, des, rsa。

@@ -564,16 +570,21 @@ import "github.com/duke-git/lancet/v2/fileutil"
 -   **<big>CurrentPath</big>** : 返回当前位置的绝对路径。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CurrentPath)]
    [[play](https://go.dev/play/p/s74a9iBGcSw)]
-   **<big>IsZipFile</big>** : 判断文件是否是zip压缩文件。
+-   **<big>IsZipFile</big>** : 判断文件是否是 zip 压缩文件。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsZipFile)]
+    [[play](https://go.dev/play/p/9M0g2j_uF_e)]
 -   **<big>FileSize</big>** : 返回文件字节大小。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#FileSize)]
+    [[play](https://go.dev/play/p/H9Z05uD-Jjc)]
 -   **<big>MTime</big>** : 返回文件修改时间(unix timestamp)。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#MTime)]
-   **<big>Sha</big>** : 返回文件sha值。
+    [[play](https://go.dev/play/p/s_Tl7lZoAaY)]
+-   **<big>Sha</big>** : 返回文件 sha 值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Sha)]
-   **<big>ReadCsvFile</big>** : 读取csv文件内容到切片。
+    [[play](https://go.dev/play/p/VfEEcO2MJYf)]
+-   **<big>ReadCsvFile</big>** : 读取 csv 文件内容到切片。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadCsvFile)]
+    [[play](https://go.dev/play/p/OExTkhGEd3_u)]

 ### 10. formatter 格式化器包含一些数据格式化处理方法。

@@ -836,16 +847,18 @@ import "github.com/duke-git/lancet/v2/netutil"
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPut)]
 -   **<big>HttpPatch<sup>deprecated</sup></big>** : 发送 http patch 请求（已弃用：SendRequest 代替）。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPatch)]
-   **<big>ParseHttpResponse</big>** : 解析http响应体到目标结构体。
+-   **<big>ParseHttpResponse</big>** : 解析 http 响应体到目标结构体。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#ParseHttpResponse)]
-   **<big>DownloadFile</big>** : 从指定的server地址下载文件。
+-   **<big>DownloadFile</big>** : 从指定的 server 地址下载文件。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#DownloadFile)]
-   **<big>UploadFile</big>** : 将文件上传指定的server地址。
+-   **<big>UploadFile</big>** : 将文件上传指定的 server 地址。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#UploadFile)]
-   **<big>IsPingConnected</big>** : 检查能否ping通主机。
+-   **<big>IsPingConnected</big>** : 检查能否 ping 通主机。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#IsPingConnected)]
-   **<big>IsTelnetConnected</big>** : 检查能否telnet到主机。
+    [[play](https://go.dev/play/p/q8OzTijsA87)]
+-   **<big>IsTelnetConnected</big>** : 检查能否 telnet 到主机。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#IsTelnetConnected)]
+    [[play](https://go.dev/play/p/yiLCGtQv_ZG)]

 ### 15. random 随机数生成器包，可以生成随机[]bytes, int, string。

@@ -983,11 +996,13 @@ import "github.com/duke-git/lancet/v2/slice"
    [[play](https://go.dev/play/p/CBKeBoHVLgq)]
 -   **<big>FindBy</big>** : 遍历切片的元素，返回第一个通过 predicate 函数真值测试的元素。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#FindBy)]
+    [[play](https://go.dev/play/p/n1lysBYl-GB)]
 -   **<big>FindLast<sup>deprecated</sup></big>** : 从头到尾遍历 slice 的元素，返回最后一个通过 predicate 函数真值测试的元素。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#FindLast)]
    [[play](https://go.dev/play/p/FFDPV_j7URd)]
-   **<big>FindLastBy</big>** : 从遍历slice的元素，返回最后一个通过predicate函数真值测试的元素。
+-   **<big>FindLastBy</big>** : 从遍历 slice 的元素，返回最后一个通过 predicate 函数真值测试的元素。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#FindLastBy)]
+    [[play](https://go.dev/play/p/8iqomzyCl_s)]
 -   **<big>Flatten</big>** : 将多维切片展平一层。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Flatten)]
    [[play](https://go.dev/play/p/hYa3cBEevtm)]
@@ -1316,16 +1331,22 @@ import "github.com/duke-git/lancet/v2/strutil"
    [[play](https://go.dev/play/p/og47F5x_jTZ)]
 -   **<big>StringToBytes</big>** : 在不分配内存的情况下将字符串转换为字节片。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#StringToBytes)]
+    [[play](https://go.dev/play/p/7OyFBrf9AxA)]
 -   **<big>BytesToString</big>** : 在不分配内存的情况下将字节切片转换为字符串。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#BytesToString)]
+    [[play](https://go.dev/play/p/6c68HRvJecH)]
 -   **<big>IsBlank</big>** : 检查字符串是否为空格或空。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#IsBlank)]
+    [[play](https://go.dev/play/p/6zXRH_c0Qd3)]
 -   **<big>HasPrefixAny</big>** : 检查字符串是否以指定字符串数组中的任何一个开头。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#HasPrefixAny)]
+    [[play](https://go.dev/play/p/8UUTl2C5slo)]
 -   **<big>HasSuffixAny</big>** : 检查字符串是否以指定字符串数组中的任何一个结尾。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#HasSuffixAny)]
-   **<big>IndexOffset</big>** : 将字符串偏移idxFrom后，返回字符串中第一个 substr 实例的索引。
+    [[play](https://go.dev/play/p/sKWpCQdOVkx)]
+-   **<big>IndexOffset</big>** : 将字符串偏移 idxFrom 后，返回字符串中第一个 substr 实例的索引。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#IndexOffset)]
+    [[play](https://go.dev/play/p/qZo4lV2fomB)]

 ### 21. system 包含 os, runtime, shell command 的相关函数。

--- a/compare/compare.go
+++ b/compare/compare.go
@@ -27,32 +27,38 @@ var (
 )

 // Equal checks if two values are equal or not. (check both type and value)
+// Play: https://go.dev/play/p/wmVxR-to4lz
 func Equal(left, right any) bool {
 	return compareValue(equal, left, right)
 }

 // EqualValue checks if two values are equal or not. (check value only)
+// Play: https://go.dev/play/p/fxnna_LLD9u
 func EqualValue(left, right any) bool {
 	ls, rs := convertor.ToString(left), convertor.ToString(right)
 	return ls == rs
 }

 // LessThan checks if value `left` less than value `right`.
+// Play: https://go.dev/play/p/cYh7FQQj0ne
 func LessThan(left, right any) bool {
 	return compareValue(lessThan, left, right)
 }

 // GreaterThan checks if value `left` greater than value `right`.
+// Play: https://go.dev/play/p/9-NYDFZmIMp
 func GreaterThan(left, right any) bool {
 	return compareValue(greaterThan, left, right)
 }

 // LessOrEqual checks if value `left` less than or equal to value `right`.
+// Play: https://go.dev/play/p/e4T_scwoQzp
 func LessOrEqual(left, right any) bool {
 	return compareValue(lessOrEqual, left, right)
 }

 // GreaterOrEqual checks if value `left` greater than or equal to value `right`.
+// Play: https://go.dev/play/p/vx8mP0U8DFk
 func GreaterOrEqual(left, right any) bool {
 	return compareValue(greaterOrEqual, left, right)
 }
--- a/convertor/convertor.go
+++ b/convertor/convertor.go
@@ -321,7 +321,7 @@ func DeepClone[T any](src T) T {

 // CopyProperties copies each field from the source into the destination. It recursively copies struct pointers and interfaces that contain struct pointers.
 // use json.Marshal/Unmarshal, so json tag should be set for fields of dst and src struct.
-// Play: todo
+// Play: https://go.dev/play/p/oZujoB5Sgg5
 func CopyProperties[T, U any](dst T, src U) error {
 	dstType, srcType := reflect.TypeOf(dst), reflect.TypeOf(src)

--- a/datetime/datetime.go
+++ b/datetime/datetime.go
@@ -218,3 +218,9 @@ func BeginOfYear(t time.Time) time.Time {
 func EndOfYear(t time.Time) time.Time {
 	return BeginOfYear(t).AddDate(1, 0, 0).Add(-time.Nanosecond)
 }
+
+// IsLeapYear check if param year is leap year or not.
+// Play: todo
+func IsLeapYear(year int) bool {
+	return year%4 == 0 && (year%100 != 0 || year%400 == 0)
+}
--- a/datetime/datetime_example_test.go
+++ b/datetime/datetime_example_test.go
@@ -321,3 +321,15 @@ func ExampleNewUnixNow() {
 // 	// Output:
 // 	// 2006-01-02T23:04:05+08:00
 // }
+
+func ExampleIsLeapYear() {
+	result1 := IsLeapYear(2000)
+	result2 := IsLeapYear(2001)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+
+	// Output:
+	// true
+	// false
+}
--- a/datetime/datetime_test.go
+++ b/datetime/datetime_test.go
@@ -230,3 +230,13 @@ func TestEndOfYear(t *testing.T) {

 	assert.Equal(expected, actual)
 }
+
+func TestIsLeapYear(t *testing.T) {
+	assert := internal.NewAssert(t, "TestEndOfYear")
+
+	result1 := IsLeapYear(2000)
+	result2 := IsLeapYear(2001)
+
+	assert.Equal(true, result1)
+	assert.Equal(false, result2)
+}
--- a/docs/convertor.md
+++ b/docs/convertor.md
@@ -757,7 +757,11 @@ func main() {

    indicatorVO := IndicatorVO{}

-    CopyProperties(&indicatorVO, indicator)
+    err := convertor.CopyProperties(&indicatorVO, indicator)
+
+    if err != nil {
+        return
+    }

    fmt.Println(indicatorVO.Id)
    fmt.Println(indicatorVO.Ip)
--- a/docs/convertor_zh-CN.md
+++ b/docs/convertor_zh-CN.md
@@ -756,7 +756,11 @@ func main() {

    indicatorVO := IndicatorVO{}

-    CopyProperties(&indicatorVO, indicator)
+    err := convertor.CopyProperties(&indicatorVO, indicator)
+
+    if err != nil {
+        return
+    }

    fmt.Println(indicatorVO.Id)
    fmt.Println(indicatorVO.Ip)
--- a/docs/datetime.md
+++ b/docs/datetime.md
@@ -53,6 +53,7 @@ import (
 -   [ToFormat](#ToFormat)
 -   [ToFormatForTpl](#ToFormatForTpl)
 -   [ToIso8601](#ToIso8601)
+-   [IsLeapYear](#IsLeapYear)

 <div STYLE="page-break-after: always;"></div>

@@ -607,8 +608,8 @@ func main() {
    now := time.Now()
    currentDate := datetime.GetNowDate()

-    fmt.Println(currentDate) 
-    
+    fmt.Println(currentDate)
+
    // Output:
    // 2022-01-28
 }
@@ -671,8 +672,8 @@ func main() {
    now := time.Now()
    current := datetime.GetNowDateTime()

-    fmt.Println(current) 
-    
+    fmt.Println(current)
+
    // Output:
    // 2022-01-28 15:59:33
 }
@@ -702,9 +703,9 @@ import (
 func main() {
    now := time.Now()
    zeroTime := datetime.GetZeroHourTimestamp()
-    
-    fmt.Println(zeroTime) 
-    
+
+    fmt.Println(zeroTime)
+
    // Output:
    // 1643299200
 }
@@ -735,8 +736,8 @@ func main() {
    now := time.Now()
    nightTime := datetime.GetNightTimestamp()

-    fmt.Println(nightTime) 
-    
+    fmt.Println(nightTime)
+
    // Output:
    // 1643385599
 }
@@ -842,8 +843,8 @@ import (

 func main() {
    tm := datetime.NewUnixNow()
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1647597438}
 }
@@ -874,8 +875,8 @@ import (

 func main() {
    tm := datetime.NewUnix(1647597438)
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1647597438}
 }
@@ -906,8 +907,8 @@ import (

 func main() {
    tm, err := datetime.NewFormat("2022-03-18 17:04:05")
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1647594245}
 }
@@ -938,8 +939,8 @@ import (

 func main() {
    tm, err := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1136214245}
 }
@@ -967,8 +968,8 @@ import (

 func main() {
    tm := datetime.NewUnixNow()
-    fmt.Println(tm.ToUnix()) 
-    
+    fmt.Println(tm.ToUnix())
+
    // Output:
    // 1647597438
 }
@@ -996,8 +997,8 @@ import (

 func main() {
    tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
-    fmt.Println(tm.ToFormat()) 
-    
+    fmt.Println(tm.ToFormat())
+
    // Output:
    // 2022-03-18 17:04:05
 }
@@ -1026,8 +1027,8 @@ import (
 func main() {
    tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
    ts := tm.ToFormatForTpl("2006/01/02 15:04:05")
-    fmt.Println(ts) 
-    
+    fmt.Println(ts)
+
    // Output:
    // 2022/03/18 17:04:05
 }
@@ -1056,9 +1057,43 @@ import (
 func main() {
    tm, _ := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
    ts := tm.ToIso8601()
-    fmt.Println(ts) 
-    
+    fmt.Println(ts)
+
    // Output:
    // 2006-01-02T23:04:05+08:00
 }
 ```
+
+
+### <span id="IsLeapYear">IsLeapYear</span>
+
+<p>check if param `year` is leap year or not.</p>
+
+<b>Signature:</b>
+
+```go
+func IsLeapYear(year int) bool
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/datetime"
+)
+
+func main() {
+    result1 := datetime.IsLeapYear(2000)
+    result2 := datetime.IsLeapYear(2001)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // true
+    // false
+}
+```
--- a/docs/datetime_zh-CN.md
+++ b/docs/datetime_zh-CN.md
@@ -1,15 +1,17 @@
 # Datetime
-datetime日期时间处理包，格式化日期，比较日期。
+
+datetime 日期时间处理包，格式化日期，比较日期。

 <div STYLE="page-break-after: always;"></div>

 ## 源码:

- [https://github.com/duke-git/lancet/blob/main/datetime/datetime.go](https://github.com/duke-git/lancet/blob/main/datetime/datetime.go)
+-   [https://github.com/duke-git/lancet/blob/main/datetime/datetime.go](https://github.com/duke-git/lancet/blob/main/datetime/datetime.go)

 <div STYLE="page-break-after: always;"></div>

 ## 用法:
+
 ```go
 import (
    "github.com/duke-git/lancet/v2/datetime"
@@ -19,74 +21,77 @@ import (
 <div STYLE="page-break-after: always;"></div>

 ## 目录
- [AddDay](#AddDay)
- [AddHour](#AddHour)
- [AddMinute](#AddMinute)
- [BeginOfMinute](#BeginOfMinute)
- [BeginOfHour](#BeginOfHour)
- [BeginOfDay](#BeginOfDay)
- [BeginOfWeek](#BeginOfWeek)
- [BeginOfMonth](#BeginOfMonth)
- [BeginOfYear](#BeginOfYear)
- [EndOfMinute](#EndOfMinute)
- [EndOfHour](#EndOfHour)
- [EndOfDay](#EndOfDay)
- [EndOfWeek](#EndOfWeek)
- [EndOfMonth](#EndOfMonth)
- [EndOfYear](#EndOfYear)
- [GetNowDate](#GetNowDate)
- [GetNowTime](#GetNowTime)
- [GetNowDateTime](#GetNowDateTime)
- [GetZeroHourTimestamp](#GetZeroHourTimestamp)
- [GetNightTimestamp](#GetNightTimestamp)
- [FormatTimeToStr](#FormatTimeToStr)
- [FormatStrToTime](#FormatStrToTime)
- [NewUnixNow](#NewUnixNow)
- [NewUnix](#NewUnix)
- [NewFormat](#NewFormat)
- [NewISO8601](#NewISO8601)
- [ToUnix](#ToUnix)
- [ToFormat](#ToFormat)
- [ToFormatForTpl](#ToFormatForTpl)
- [ToIso8601](#ToIso8601)
+
+-   [AddDay](#AddDay)
+-   [AddHour](#AddHour)
+-   [AddMinute](#AddMinute)
+-   [BeginOfMinute](#BeginOfMinute)
+-   [BeginOfHour](#BeginOfHour)
+-   [BeginOfDay](#BeginOfDay)
+-   [BeginOfWeek](#BeginOfWeek)
+-   [BeginOfMonth](#BeginOfMonth)
+-   [BeginOfYear](#BeginOfYear)
+-   [EndOfMinute](#EndOfMinute)
+-   [EndOfHour](#EndOfHour)
+-   [EndOfDay](#EndOfDay)
+-   [EndOfWeek](#EndOfWeek)
+-   [EndOfMonth](#EndOfMonth)
+-   [EndOfYear](#EndOfYear)
+-   [GetNowDate](#GetNowDate)
+-   [GetNowTime](#GetNowTime)
+-   [GetNowDateTime](#GetNowDateTime)
+-   [GetZeroHourTimestamp](#GetZeroHourTimestamp)
+-   [GetNightTimestamp](#GetNightTimestamp)
+-   [FormatTimeToStr](#FormatTimeToStr)
+-   [FormatStrToTime](#FormatStrToTime)
+-   [NewUnixNow](#NewUnixNow)
+-   [NewUnix](#NewUnix)
+-   [NewFormat](#NewFormat)
+-   [NewISO8601](#NewISO8601)
+-   [ToUnix](#ToUnix)
+-   [ToFormat](#ToFormat)
+-   [ToFormatForTpl](#ToFormatForTpl)
+-   [ToIso8601](#ToIso8601)
+-   [IsLeapYear](#IsLeapYear)

 <div STYLE="page-break-after: always;"></div>

 ## 文档

 ## 注:
-1. 方法FormatTimeToStr和FormatStrToTime中的format参数值需要传以下类型之一：
- yyyy-mm-dd hh:mm:ss
- yyyy-mm-dd hh:mm
- yyyy-mm-dd hh
- yyyy-mm-dd
- yyyy-mm
- mm-dd
- dd-mm-yy hh:mm:ss
- yyyy/mm/dd hh:mm:ss
- yyyy/mm/dd hh:mm
- yyyy-mm-dd hh
- yyyy/mm/dd
- yyyy/mm
- mm/dd
- dd/mm/yy hh:mm:ss
- yyyy
- mm
- hh:mm:ss
- mm:ss

+1. 方法 FormatTimeToStr 和 FormatStrToTime 中的 format 参数值需要传以下类型之一：
+
+-   yyyy-mm-dd hh:mm:ss
+-   yyyy-mm-dd hh:mm
+-   yyyy-mm-dd hh
+-   yyyy-mm-dd
+-   yyyy-mm
+-   mm-dd
+-   dd-mm-yy hh:mm:ss
+-   yyyy/mm/dd hh:mm:ss
+-   yyyy/mm/dd hh:mm
+-   yyyy-mm-dd hh
+-   yyyy/mm/dd
+-   yyyy/mm
+-   mm/dd
+-   dd/mm/yy hh:mm:ss
+-   yyyy
+-   mm
+-   hh:mm:ss
+-   mm:ss

 ### <span id="AddDay">AddDay</span>

 <p>将日期加/减天数。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func AddDay(t time.Time, day int64) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -119,13 +124,13 @@ func main() {

 <p>将日期加/减小时数。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func AddHour(t time.Time, hour int64) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -158,13 +163,13 @@ func main() {

 <p>将日期加/减分钟数。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func AddMinute(t time.Time, minute int64) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -197,13 +202,13 @@ func main() {

 <p>返回指定时间的分钟开始时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func BeginOfMinute(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -229,13 +234,13 @@ func main() {

 <p>返回指定时间的小时开始时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func BeginOfHour(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -261,13 +266,13 @@ func main() {

 <p>返回指定时间的当天开始时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func BeginOfDay(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -293,13 +298,13 @@ func main() {

 <p>返回指定时间的每周开始时间,默认开始时间星期日。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func BeginOfWeek(t time.Time, beginFrom ...time.Weekday) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -325,13 +330,13 @@ func main() {

 <p>返回指定时间的当月开始时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func BeginOfMonth(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -357,13 +362,13 @@ func main() {

 <p>返回指定时间的当年开始时间</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func BeginOfYear(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -389,13 +394,13 @@ func main() {

 <p>返回指定时间的分钟结束时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func EndOfMinute(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -421,13 +426,13 @@ func main() {

 <p>返回指定时间的小时结束时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func EndOfHour(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -453,13 +458,13 @@ func main() {

 <p>返回指定时间的当天结束时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func EndOfDay(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -485,13 +490,13 @@ func main() {

 <p>返回指定时间的星期结束时间,默认结束时间星期六。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func EndOfWeek(t time.Time, endWith ...time.Weekday) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -517,13 +522,13 @@ func main() {

 <p>返回指定时间的当月结束时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func EndOfMonth(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -549,13 +554,13 @@ func main() {

 <p>返回指定时间的当年结束时间。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func EndOfYear(t time.Time) time.Time
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -581,13 +586,13 @@ func main() {

 <p>获取当天日期，返回格式：yyyy-mm-dd。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func GetNowDate() string
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -602,8 +607,8 @@ func main() {
    now := time.Now()
    currentDate := datetime.GetNowDate()

-    fmt.Println(currentDate) 
-    
+    fmt.Println(currentDate)
+
    // Output:
    // 2022-01-28
 }
@@ -613,13 +618,13 @@ func main() {

 <p>获取当时时间，返回格式：hh:mm:ss</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func GetNowTime() string
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -645,13 +650,13 @@ func main() {

 <p>获取当时日期和时间，返回格式：yyyy-mm-dd hh:mm:ss。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func GetNowDateTime() string
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -666,8 +671,8 @@ func main() {
    now := time.Now()
    current := datetime.GetNowDateTime()

-    fmt.Println(current) 
-    
+    fmt.Println(current)
+
    // Output:
    // 2022-01-28 15:59:33
 }
@@ -677,13 +682,13 @@ func main() {

 <p>获取零点时间戳(timestamp of 00:00)</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func GetZeroHourTimestamp() int64
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -697,9 +702,9 @@ import (
 func main() {
    now := time.Now()
    zeroTime := datetime.GetZeroHourTimestamp()
-    
-    fmt.Println(zeroTime) 
-    
+
+    fmt.Println(zeroTime)
+
    // Output:
    // 1643299200
 }
@@ -709,13 +714,13 @@ func main() {

 <p>获取午夜时间戳(timestamp of 23:59)。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func GetNightTimestamp() int64
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -730,8 +735,8 @@ func main() {
    now := time.Now()
    nightTime := datetime.GetNightTimestamp()

-    fmt.Println(nightTime) 
-    
+    fmt.Println(nightTime)
+
    // Output:
    // 1643385599
 }
@@ -741,13 +746,13 @@ func main() {

 <p>将日期格式化成字符串，`format` 参数格式参考注1。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func FormatTimeToStr(t time.Time, format string) string
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -780,13 +785,13 @@ func main() {

 <p>将字符串格式化成时间，`format` 参数格式参考注1。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func FormatStrToTime(str, format string) (time.Time, error)
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -816,7 +821,7 @@ func main() {

 <p>创建一个当前时间的unix时间戳。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 type theTime struct {
@@ -825,7 +830,7 @@ type theTime struct {
 func NewUnixNow() *theTime
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -837,8 +842,8 @@ import (

 func main() {
    tm := datetime.NewUnixNow()
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1647597438}
 }
@@ -848,7 +853,7 @@ func main() {

 <p>创建一个unix时间戳。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 type theTime struct {
@@ -857,7 +862,7 @@ type theTime struct {
 func NewUnix(unix int64) *theTime
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -869,8 +874,8 @@ import (

 func main() {
    tm := datetime.NewUnix(1647597438)
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1647597438}
 }
@@ -880,7 +885,7 @@ func main() {

 <p>创建一个yyyy-mm-dd hh:mm:ss格式时间字符串的unix时间戳。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 type theTime struct {
@@ -889,7 +894,7 @@ type theTime struct {
 func NewFormat(t string) (*theTime, error)
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -901,8 +906,8 @@ import (

 func main() {
    tm, err := datetime.NewFormat("2022-03-18 17:04:05")
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1647594245}
 }
@@ -912,7 +917,7 @@ func main() {

 <p>创建一个iso8601格式时间字符串的unix时间戳。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 type theTime struct {
@@ -921,7 +926,7 @@ type theTime struct {
 func NewISO8601(iso8601 string) (*theTime, error)
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -933,8 +938,8 @@ import (

 func main() {
    tm, err := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
-    fmt.Println(tm) 
-    
+    fmt.Println(tm)
+
    // Output:
    // &{1136214245}
 }
@@ -944,13 +949,13 @@ func main() {

 <p>返回unix时间戳。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func (t *theTime) ToUnix() int64
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -962,8 +967,8 @@ import (

 func main() {
    tm := datetime.NewUnixNow()
-    fmt.Println(tm.ToUnix()) 
-    
+    fmt.Println(tm.ToUnix())
+
    // Output:
    // 1647597438
 }
@@ -973,13 +978,13 @@ func main() {

 <p>返回格式'yyyy-mm-dd hh:mm:ss'的日期字符串。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func (t *theTime) ToFormat() string
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -991,8 +996,8 @@ import (

 func main() {
    tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
-    fmt.Println(tm.ToFormat()) 
-    
+    fmt.Println(tm.ToFormat())
+
    // Output:
    // 2022-03-18 17:04:05
 }
@@ -1002,13 +1007,13 @@ func main() {

 <p>返回tpl格式指定的日期字符串。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func (t *theTime) ToFormatForTpl(tpl string) string
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -1021,8 +1026,8 @@ import (
 func main() {
    tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
    ts := tm.ToFormatForTpl("2006/01/02 15:04:05")
-    fmt.Println(ts) 
-    
+    fmt.Println(ts)
+
    // Output:
    // 2022/03/18 17:04:05
 }
@@ -1032,13 +1037,13 @@ func main() {

 <p>返回iso8601日期字符串。</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func (t *theTime) ToIso8601() string
 ```

-<b>Example:</b>
+<b>示例:</b>

 ```go
 package main
@@ -1051,9 +1056,43 @@ import (
 func main() {
    tm, _ := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
    ts := tm.ToIso8601()
-    fmt.Println(ts) 
-    
+    fmt.Println(ts)
+
    // Output:
    // 2006-01-02T23:04:05+08:00
 }
+```
+
+
+### <span id="IsLeapYear">IsLeapYear</span>
+
+<p>验证是否是闰年。</p>
+
+<b>函数签名:</b>
+
+```go
+func IsLeapYear(year int) bool
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/datetime"
+)
+
+func main() {
+    result1 := datetime.IsLeapYear(2000)
+    result2 := datetime.IsLeapYear(2001)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // true
+    // false
+}
 ```
--- a/docs/fileutil.md
+++ b/docs/fileutil.md
@@ -522,7 +522,7 @@ import (
 )

 func main() {
-    isZip := IsZipFile("./zipfile.zip")
+    isZip := fileutil.IsZipFile("./zipfile.zip")
    fmt.Println(isZip)
 }
 ```
--- a/docs/fileutil_zh-CN.md
+++ b/docs/fileutil_zh-CN.md
@@ -522,7 +522,7 @@ import (
 )

 func main() {
-    isZip := IsZipFile("./zipfile.zip")
+    isZip := fileutil.IsZipFile("./zipfile.zip")
    fmt.Println(isZip)
 }
 ```
--- a/docs/mathutil.md
+++ b/docs/mathutil.md
@@ -40,6 +40,8 @@ import (
 -   [RadianToAngle](#RadianToAngle)
 -   [PointDistance](#PointDistance)
 -   [IsPrime](#IsPrime)
+-   [GCD](#GCD)
+-   [LCM](#LCM)

 <div STYLE="page-break-after: always;"></div>

@@ -702,4 +704,83 @@ func main() {
 	// false
 	// true
 }
+```
+
+### <span id="GCD">GCD</span>
+
+<p>Return greatest common divisor (GCD) of integers.</p>
+
+<b>Signature:</b>
+
+```go
+func GCD[T constraints.Integer](integers ...T) T
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.GCD(1, 1)
+	result2 := mathutil.GCD(1, -1)
+	result3 := mathutil.GCD(-1, 1)
+	result4 := mathutil.GCD(-1, -1)
+	result5 := mathutil.GCD(3, 6, 9)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+	fmt.Println(result5)
+
+	// Output:
+	// 1
+	// 1
+	// -1
+	// -1
+	// 3
+}
+```
+
+
+### <span id="LCM">LCM</span>
+
+<p>Return Least Common Multiple (LCM) of integers.</p>
+
+<b>Signature:</b>
+
+```go
+func LCM[T constraints.Integer](integers ...T) T
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.LCM(1, 1)
+	result2 := mathutil.LCM(1, 2)
+	result3 := mathutil.LCM(3, 6, 9)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 1
+	// 2
+	// 18
+}
 ```
--- a/docs/mathutil_zh-CN.md
+++ b/docs/mathutil_zh-CN.md
@@ -40,6 +40,8 @@ import (
 -   [RadianToAngle](#RadianToAngle)
 -   [PointDistance](#PointDistance)
 -   [IsPrime](#IsPrime)
+-   [GCD](#GCD)
+-   [LCM](#LCM)

 <div STYLE="page-break-after: always;"></div>

@@ -701,4 +703,84 @@ func main() {
 	// false
 	// false
 	// true
-}
+}
+```
+
+### <span id="GCD">GCD</span>
+
+<p>计算最大公约数。</p>
+
+<b>函数签名:</b>
+
+```go
+func GCD[T constraints.Integer](integers ...T) T
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.GCD(1, 1)
+	result2 := mathutil.GCD(1, -1)
+	result3 := mathutil.GCD(-1, 1)
+	result4 := mathutil.GCD(-1, -1)
+	result5 := mathutil.GCD(3, 6, 9)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+	fmt.Println(result5)
+
+	// Output:
+	// 1
+	// 1
+	// -1
+	// -1
+	// 3
+}
+```
+
+
+### <span id="LCM">LCM</span>
+
+<p>计算最小公倍数。</p>
+
+<b>函数签名:</b>
+
+```go
+func LCM[T constraints.Integer](integers ...T) T
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.LCM(1, 1)
+	result2 := mathutil.LCM(1, 2)
+	result3 := mathutil.LCM(3, 6, 9)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 1
+	// 2
+	// 18
+}
+```
--- a/docs/netutil.md
+++ b/docs/netutil.md
@@ -922,7 +922,7 @@ import (
 )

 func main() {
-    err := DownloadFile("./lancet_logo.jpg", "https://picx.zhimg.com/v2-fc82a4199749de9cfb71e32e54f489d3_720w.jpg?source=172ae18b")
+    err := netutil.DownloadFile("./lancet_logo.jpg", "https://picx.zhimg.com/v2-fc82a4199749de9cfb71e32e54f489d3_720w.jpg?source=172ae18b")

    fmt.Println(err)
 }
--- a/docs/netutil_zh-CN.md
+++ b/docs/netutil_zh-CN.md
@@ -924,7 +924,7 @@ import (
 )

 func main() {
-    err := DownloadFile("./lancet_logo.jpg", "https://picx.zhimg.com/v2-fc82a4199749de9cfb71e32e54f489d3_720w.jpg?source=172ae18b")
+    err := netutil.DownloadFile("./lancet_logo.jpg", "https://picx.zhimg.com/v2-fc82a4199749de9cfb71e32e54f489d3_720w.jpg?source=172ae18b")

    fmt.Println(err)
 }
--- a/docs/strutil.md
+++ b/docs/strutil.md
@@ -968,6 +968,7 @@ func main() {

    fmt.Println(result1)
    fmt.Println(result2)
+
    // Output:
    // hello world
    // 你好😄
@@ -998,6 +999,7 @@ func main() {

 	fmt.Println(result1)
 	fmt.Println(result2)
+
 	// Output:
 	// [97 98 99]
 	// true
@@ -1027,6 +1029,7 @@ func main() {
 	result := strutil.BytesToString(bytes)

 	fmt.Println(result)
+
 	// Output:
 	// abc
 }
@@ -1058,6 +1061,7 @@ func main() {
 	fmt.Println(result1)
 	fmt.Println(result2)
 	fmt.Println(result3)
+
 	// Output:
 	// true
 	// true
@@ -1089,6 +1093,7 @@ func main() {

 	fmt.Println(result1)
 	fmt.Println(result2)
+
 	// Output:
 	// true
 	// false
@@ -1119,6 +1124,7 @@ func main() {

 	fmt.Println(result1)
 	fmt.Println(result2)
+
 	// Output:
 	// true
 	// false
@@ -1157,6 +1163,7 @@ func main() {
 	fmt.Println(result3)
 	fmt.Println(result4)
 	fmt.Println(result5)
+    
 	// Output:
 	// 12
 	// 1
--- a/docs/strutil_zh-CN.md
+++ b/docs/strutil_zh-CN.md
@@ -968,6 +968,7 @@ func main() {

    fmt.Println(result1)
    fmt.Println(result2)
+    
    // Output:
    // hello world
    // 你好😄
@@ -1027,6 +1028,7 @@ func main() {
 	result := strutil.BytesToString(bytes)

 	fmt.Println(result)
+
 	// Output:
 	// abc
 }
@@ -1058,6 +1060,7 @@ func main() {
 	fmt.Println(result1)
 	fmt.Println(result2)
 	fmt.Println(result3)
+
 	// Output:
 	// true
 	// true
@@ -1089,6 +1092,7 @@ func main() {

 	fmt.Println(result1)
 	fmt.Println(result2)
+
 	// Output:
 	// true
 	// false
@@ -1119,6 +1123,7 @@ func main() {

 	fmt.Println(result1)
 	fmt.Println(result2)
+
 	// Output:
 	// true
 	// false
@@ -1157,6 +1162,7 @@ func main() {
 	fmt.Println(result3)
 	fmt.Println(result4)
 	fmt.Println(result5)
+
 	// Output:
 	// 12
 	// 1
--- a/fileutil/file.go
+++ b/fileutil/file.go
@@ -180,7 +180,7 @@ func ListFileNames(path string) ([]string, error) {
 }

 // IsZipFile checks if file is zip or not.
-// Play: todo
+// Play: https://go.dev/play/p/9M0g2j_uF_e
 func IsZipFile(filepath string) bool {
 	f, err := os.Open(filepath)
 	if err != nil {
@@ -383,7 +383,7 @@ func CurrentPath() string {
 }

 // FileSize returns file size in bytes.
-// Play: todo
+// Play: https://go.dev/play/p/H9Z05uD-Jjc
 func FileSize(path string) (int64, error) {
 	f, err := os.Stat(path)
 	if err != nil {
@@ -393,7 +393,7 @@ func FileSize(path string) (int64, error) {
 }

 // MTime returns file modified time.
-// Play: todo
+// Play: https://go.dev/play/p/s_Tl7lZoAaY
 func MTime(filepath string) (int64, error) {
 	f, err := os.Stat(filepath)
 	if err != nil {
@@ -403,7 +403,7 @@ func MTime(filepath string) (int64, error) {
 }

 // MTime returns file sha value, param `shaType` should be 1, 256 or 512.
-// Play: todo
+// Play: https://go.dev/play/p/VfEEcO2MJYf
 func Sha(filepath string, shaType ...int) (string, error) {
 	file, err := os.Open(filepath)
 	if err != nil {
@@ -437,7 +437,7 @@ func Sha(filepath string, shaType ...int) (string, error) {
 }

 // ReadCsvFile read file content into slice.
-// Play: todo
+// Play: https://go.dev/play/p/OExTkhGEd3_u
 func ReadCsvFile(filepath string) ([][]string, error) {
 	f, err := os.Open(filepath)
 	if err != nil {
--- a/mathutil/mathutil.go
+++ b/mathutil/mathutil.go
@@ -256,3 +256,48 @@ func IsPrime(n int) bool {

 	return true
 }
+
+// GCD return greatest common divisor (GCD) of integers.
+// Play: todo
+func GCD[T constraints.Integer](integers ...T) T {
+	result := integers[0]
+
+	for k := range integers {
+		result = gcd(integers[k], result)
+
+		if result == 1 {
+			return 1
+		}
+	}
+
+	return result
+}
+
+// find greatest common divisor (GCD)
+func gcd[T constraints.Integer](a, b T) T {
+	if b == 0 {
+		return a
+	}
+
+	return gcd(b, a%b)
+}
+
+// LCM return Least Common Multiple (LCM) of integers.
+// Play: todo
+func LCM[T constraints.Integer](integers ...T) T {
+	result := integers[0]
+
+	for k := range integers {
+		result = lcm(integers[k], result)
+	}
+
+	return result
+}
+
+// find Least Common Multiple (LCM) via GCD.
+func lcm[T constraints.Integer](a, b T) T {
+	if a == 0 || b == 0 {
+		panic("lcm function: provide non zero integers only.")
+	}
+	return a * b / gcd(a, b)
+}
--- a/mathutil/mathutil_exmaple_test.go
+++ b/mathutil/mathutil_exmaple_test.go
@@ -281,3 +281,39 @@ func ExampleIsPrime() {
 	// false
 	// true
 }
+
+func ExampleGCD() {
+	result1 := GCD(1, 1)
+	result2 := GCD(1, -1)
+	result3 := GCD(-1, 1)
+	result4 := GCD(-1, -1)
+	result5 := GCD(3, 6, 9)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+	fmt.Println(result5)
+
+	// Output:
+	// 1
+	// 1
+	// -1
+	// -1
+	// 3
+}
+
+func ExampleLCM() {
+	result1 := LCM(1, 1)
+	result2 := LCM(1, 2)
+	result3 := LCM(3, 6, 9)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 1
+	// 2
+	// 18
+}
--- a/mathutil/mathutil_test.go
+++ b/mathutil/mathutil_test.go
@@ -210,3 +210,41 @@ func TestIsPrime(t *testing.T) {
 	assert.Equal(true, IsPrime(3))
 	assert.Equal(false, IsPrime(4))
 }
+
+func TestGCD(t *testing.T) {
+	assert := internal.NewAssert(t, "TestGCD")
+
+	assert.Equal(1, GCD(1, 1))
+	assert.Equal(1, GCD(1, -1))
+	assert.Equal(-1, GCD(-1, 1))
+	assert.Equal(-1, GCD(-1, -1))
+
+	assert.Equal(1, GCD(1, 0))
+	assert.Equal(1, GCD(0, 1))
+	assert.Equal(-1, GCD(-1, 0))
+	assert.Equal(-1, GCD(0, -1))
+
+	assert.Equal(1, GCD(1, -2))
+	assert.Equal(1, GCD(-2, 1))
+	assert.Equal(-1, GCD(-1, 2))
+	assert.Equal(-1, GCD(2, -1))
+
+	assert.Equal(-1, GCD(-1, -2))
+	assert.Equal(-1, GCD(-2, -1))
+
+	assert.Equal(-9, GCD(-27, -36))
+	assert.Equal(3, GCD(3, 6, 9))
+}
+
+func TestLCM(t *testing.T) {
+	assert := internal.NewAssert(t, "TestLCM")
+
+	assert.Equal(1, LCM(1))
+	assert.Equal(-1, LCM(-1))
+	assert.Equal(-1, LCM(1, -1))
+	assert.Equal(1, LCM(-1, 1))
+	assert.Equal(1, LCM(1, 1))
+	assert.Equal(-1, LCM(-1, -1))
+	assert.Equal(2, LCM(1, 2))
+	assert.Equal(18, LCM(3, 6, 9))
+}
--- a/netutil/net.go
+++ b/netutil/net.go
@@ -11,6 +11,7 @@ import (
 	"net/url"
 	"os"
 	"os/exec"
+	"runtime"
 	"strings"
 	"time"

@@ -249,9 +250,14 @@ func DownloadFile(filepath string, url string) error {
 }

 // IsPingConnected checks if can ping specified host or not.
-// Play: todo
+// Play: https://go.dev/play/p/q8OzTijsA87
 func IsPingConnected(host string) bool {
-	cmd := exec.Command("ping", host, "-c", "1", "-W", "6")
+	cmd := exec.Command("ping", host, "-c", "4", "-W", "6")
+
+	if runtime.GOOS == "windows" {
+		cmd = exec.Command("ping", host, "-n", "4", "-w", "6")
+	}
+
 	err := cmd.Run()
 	if err != nil {
 		return false
@@ -260,7 +266,7 @@ func IsPingConnected(host string) bool {
 }

 // IsTelnetConnected checks if can telnet specified host or not.
-// Play: todo
+// Play: https://go.dev/play/p/yiLCGtQv_ZG
 func IsTelnetConnected(host string, port string) bool {
 	adder := host + ":" + port
 	conn, err := net.DialTimeout("tcp", adder, 5*time.Second)
--- a/netutil/net_test.go
+++ b/netutil/net_test.go
@@ -121,7 +121,7 @@ func TestIsPingConnected(t *testing.T) {
 	assert := internal.NewAssert(t, "TestIsPingConnected")

 	// in github action env, this will fail
-	// result1 := IsPingConnected("bing.com")
+	// result1 := IsPingConnected("www.baidu.com")
 	// assert.Equal(true, result1)

 	result2 := IsPingConnected("www.!@#&&&.com")
--- a/slice/slice.go
+++ b/slice/slice.go
@@ -338,7 +338,7 @@ func FindLast[T any](slice []T, predicate func(index int, item T) bool) (*T, boo
 // FindBy iterates over elements of slice, returning the first one that passes a truth test on predicate function.
 // If return T is nil or zero value then no items matched the predicate func.
 // In contrast to Find or FindLast, its return value no longer requires dereferencing
-// Play: todo
+// Play: https://go.dev/play/p/n1lysBYl-GB
 func FindBy[T any](slice []T, predicate func(index int, item T) bool) (v T, ok bool) {
 	index := -1

@@ -359,7 +359,7 @@ func FindBy[T any](slice []T, predicate func(index int, item T) bool) (v T, ok b
 // FindLastBy iterates over elements of slice, returning the last one that passes a truth test on predicate function.
 // If return T is nil or zero value then no items matched the predicate func.
 // In contrast to Find or FindLast, its return value no longer requires dereferencing
-// Play: todo
+// Play: https://go.dev/play/p/8iqomzyCl_s
 func FindLastBy[T any](slice []T, predicate func(index int, item T) bool) (v T, ok bool) {
 	index := -1

--- a/strutil/string.go
+++ b/strutil/string.go
@@ -377,7 +377,7 @@ func RemoveNonPrintable(str string) string {
 }

 // StringToBytes converts a string to byte slice without a memory allocation.
-// Play: todo
+// Play: https://go.dev/play/p/7OyFBrf9AxA
 func StringToBytes(str string) (b []byte) {
 	sh := *(*reflect.StringHeader)(unsafe.Pointer(&str))
 	bh := (*reflect.SliceHeader)(unsafe.Pointer(&b))
@@ -386,13 +386,13 @@ func StringToBytes(str string) (b []byte) {
 }

 // BytesToString converts a byte slice to string without a memory allocation.
-// Play: todo
+// Play: https://go.dev/play/p/6c68HRvJecH
 func BytesToString(bytes []byte) string {
 	return *(*string)(unsafe.Pointer(&bytes))
 }

 // IsBlank checks if a string is whitespace, empty.
-// Play: todo
+// Play: https://go.dev/play/p/6zXRH_c0Qd3
 func IsBlank(str string) bool {
 	if len(str) == 0 {
 		return true
@@ -408,7 +408,7 @@ func IsBlank(str string) bool {
 }

 // HasPrefixAny check if a string starts with any of an array of specified strings.
-// Play: todo
+// Play: https://go.dev/play/p/8UUTl2C5slo
 func HasPrefixAny(str string, prefixes []string) bool {
 	if len(str) == 0 || len(prefixes) == 0 {
 		return false
@@ -422,7 +422,7 @@ func HasPrefixAny(str string, prefixes []string) bool {
 }

 // HasSuffixAny check if a string ends with any of an array of specified strings.
-// Play: todo
+// Play: https://go.dev/play/p/sKWpCQdOVkx
 func HasSuffixAny(str string, suffixes []string) bool {
 	if len(str) == 0 || len(suffixes) == 0 {
 		return false
@@ -437,7 +437,7 @@ func HasSuffixAny(str string, suffixes []string) bool {

 // IndexOffset returns the index of the first instance of substr in string after offsetting the string by `idxFrom`,
 // or -1 if substr is not present in string.
-// Play: todo
+// Play: https://go.dev/play/p/qZo4lV2fomB
 func IndexOffset(str string, substr string, idxFrom int) int {
 	if idxFrom > len(str)-1 || idxFrom < 0 {
 		return -1
--- a/strutil/string_example_test.go
+++ b/strutil/string_example_test.go
@@ -394,22 +394,19 @@ func ExampleSplitWords() {

 	result1 := SplitWords("a word")
 	result2 := SplitWords("I'am a programmer")
-	result3 := SplitWords("Bonjour, je suis programmeur")
-	result4 := SplitWords("a -b-c' 'd'e")
-	result5 := SplitWords("你好，我是一名码农")
-	result6 := SplitWords("こんにちは，私はプログラマーです")
+	result3 := SplitWords("a -b-c' 'd'e")
+	result4 := SplitWords("你好，我是一名码农")
+	result5 := SplitWords("こんにちは，私はプログラマーです")

 	fmt.Println(result1)
 	fmt.Println(result2)
 	fmt.Println(result3)
 	fmt.Println(result4)
 	fmt.Println(result5)
-	fmt.Println(result6)

 	// Output:
 	// [a word]
 	// [I'am a programmer]
-	// [Bonjour je suis programmeur]
 	// [a b-c' d'e]
 	// []
 	// []
--- a/strutil/string_test.go
+++ b/strutil/string_test.go
@@ -314,11 +314,10 @@ func TestSplitWords(t *testing.T) {
 	assert := internal.NewAssert(t, "TestSplitWords")

 	cases := map[string][]string{
-		"a word":                       {"a", "word"},
-		"I'am a programmer":            {"I'am", "a", "programmer"},
-		"Bonjour, je suis programmeur": {"Bonjour", "je", "suis", "programmeur"},
-		"a -b-c' 'd'e":                 {"a", "b-c'", "d'e"},
-		"你好，我是一名码农":                    nil,
+		"a word":            {"a", "word"},
+		"I'am a programmer": {"I'am", "a", "programmer"},
+		"a -b-c' 'd'e":      {"a", "b-c'", "d'e"},
+		"你好，我是一名码农":         nil,
 		"こんにちは，私はプログラマーです": nil,
 	}

@@ -331,11 +330,10 @@ func TestWordCount(t *testing.T) {
 	assert := internal.NewAssert(t, "TestSplitWords")

 	cases := map[string]int{
-		"a word":                       2, //   {"a", "word"},
-		"I'am a programmer":            3, //   {"I'am", "a", "programmer"},
-		"Bonjour, je suis programmeur": 4, // {"Bonjour", "je", "suis", "programmeur"},
-		"a -b-c' 'd'e":                 3, // {"a", "b-c'", "d'e"},
-		"你好，我是一名码农":                    0, // nil,
+		"a word":            2, //   {"a", "word"},
+		"I'am a programmer": 3, //   {"I'am", "a", "programmer"},
+		"a -b-c' 'd'e":      3, // {"a", "b-c'", "d'e"},
+		"你好，我是一名码农":         0, // nil,
 		"こんにちは，私はプログラマーです": 0, // nil,
 	}
Author	SHA1	Message	Date
dudaodong	e2aeb8ec07	doc: add document for GCD and LCM function	2023-05-06 11:28:38 +08:00
dudaodong	654ba15aaf	feat: add GCD and LCM function	2023-05-06 11:02:00 +08:00
dudaodong	945c59896b	feat: add IsLeapYear	2023-04-28 14:42:25 +08:00
dudaodong	219e31d929	fix: fix format issue	2023-04-27 15:49:58 +08:00
dudaodong	82cb86b35c	doc: add go playground demo for compare package	2023-04-27 14:15:25 +08:00
dudaodong	f93c561f5d	doc: update go playground demo	2023-04-27 12:03:15 +08:00
dudaodong	4888909208	fix: fix IsPingConnected failed in windows	2023-04-26 19:53:53 +08:00
dudaodong	33c8875d14	test: update TestWordCount	2023-04-26 19:35:28 +08:00