doc: add new function to readme file

2026-02-04 12:52:28 +08:00 · 2023-06-01 10:44:00 +08:00
parent 8944109c4c
commit e54c9b2850
4 changed files with 47 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -491,7 +491,12 @@ import "github.com/duke-git/lancet/v2/datetime"
 -   **<big>IsLeapYear</big>** : check if param `year` is leap year or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#IsLeapYear)]
    [[play](https://go.dev/play/p/xS1eS2ejGew)]
-
+-   **<big>BetweenSeconds</big>** : returns the number of seconds between two times.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BetweenSeconds)]
+-   **<big>DayOfYear</big>** : returns which day of the year the parameter date `t` is.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#DayOfYear)]
+-   **<big>IsWeekend</big>** : checks if passed time is weekend or not.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#IsWeekend)]

 ### 8. Datastructure package constains some common data structure. eg. list, linklist, stack, queue, set, tree, graph.

@@ -596,6 +601,10 @@ import "github.com/duke-git/lancet/v2/fileutil"
 -   **<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)]
+-   **<big>WriteBytesToFile</big>** : write bytes to target file.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#WriteBytesToFile)]
+-   **<big>WriteStringToFile</big>** : write string to target file.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#WriteStringToFile)]

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

@@ -803,6 +812,10 @@ import "github.com/duke-git/lancet/v2/mathutil"
 -   **<big>LCM</big>** : return Least Common Multiple (LCM) of integers.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#LCM)]
    [[play](https://go.dev/play/p/EjcZxfY7G_g)]
+-   **<big>Cos</big>** : return the cosine of the radian argument.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Cos)]
+-   **<big>Sin</big>** : return the sine of the radian argument.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Sin)]

 ### 14. Netutil package contains functions to get net information and send http request.

@@ -1292,6 +1305,10 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>Capitalize</big>** : converts the first character of source string to upper case and the remaining to lower case.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Capitalize)]
    [[play](https://go.dev/play/p/2OAjgbmAqHZ)]
+-   **<big>ContainsAll</big>** : return true if target string contains all the substrings.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#ContainsAll)]
+-   **<big>ContainsAny</big>** : return true if target string contains any one of the substrings.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#ContainsAny)]
 -   **<big>IsString</big>** : checks if the parameter value data type is string or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#IsString)]
    [[play](https://go.dev/play/p/IOgq7oF9ERm)]
@@ -1373,6 +1390,8 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>SplitAndTrim</big>** : splits string `str` by a string `delimiter` to a slice, and calls Trim to every element of slice.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#SplitAndTrim)]
    [[play](https://go.dev/play/p/ZNL6o4SkYQ7)]
+-   **<big>HideString</big>** : Hide some chars in source string with param `replaceChar`.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#HideString)]

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

--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -490,6 +490,15 @@ import "github.com/duke-git/lancet/v2/datetime"
 -   **<big>IsLeapYear</big>** :验证是否是闰年。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#IsLeapYear)]
    [[play](https://go.dev/play/p/xS1eS2ejGew)]
+-   **<big>IsLeapYear</big>** : check if param `year` is leap year or not.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#IsLeapYear)]
+    [[play](https://go.dev/play/p/xS1eS2ejGew)]
+-   **<big>BetweenSeconds</big>** : 返回两个时间的间隔秒数。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#BetweenSeconds)]
+-   **<big>DayOfYear</big>** : 返回参数日期是一年中的第几天。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#DayOfYear)]
+-   **<big>IsWeekend</big>** : 判断日期是否是周末。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#IsWeekend)]

 ### 8. datastructure 包含一些普通的数据结构实现。例如：list, linklist, stack, queue, set, tree, graph.

@@ -594,6 +603,10 @@ import "github.com/duke-git/lancet/v2/fileutil"
 -   **<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)]
+-   **<big>WriteBytesToFile</big>** : 将bytes写入文件。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#WriteBytesToFile)]
+-   **<big>WriteStringToFile</big>** : 将字符串写入文件。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#WriteStringToFile)]

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

@@ -801,6 +814,10 @@ import "github.com/duke-git/lancet/v2/mathutil"
 -   **<big>LCM</big>** : 求最小公倍数。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#LCM)]
    [[play](https://go.dev/play/p/EjcZxfY7G_g)]
+-   **<big>Cos</big>** : 计算弧度的余弦值。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Cos)]
+-   **<big>Sin</big>** : 计算弧度的正弦值。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Sin)]

 ### 14. netutil 网络包支持获取 ip 地址，发送 http 请求。

@@ -1293,6 +1310,10 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>Capitalize</big>** : 将字符串的第一个字符转换为大写。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#Capitalize)]
    [[play](https://go.dev/play/p/2OAjgbmAqHZ)]
+-   **<big>ContainsAll</big>** : 判断字符串是否包括全部给定的子字符串切片。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#ContainsAll)]
+-   **<big>ContainsAny</big>** : 判断字符串是否包括给定的子字符串切片中任意一个子字符串。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#ContainsAny)]
 -   **<big>IsString</big>** : 判断传入参数的数据类型是否为字符串。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#IsString)]
    [[play](https://go.dev/play/p/IOgq7oF9ERm)]
@@ -1374,6 +1395,8 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>SplitAndTrim</big>** : 将字符串 str 按字符串 delimiter 拆分为一个切片，并对该数组的每个元素调用 Trim。忽略 Trim 后为空的元素。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#SplitAndTrim)]
    [[play](https://go.dev/play/p/ZNL6o4SkYQ7)]
+-   **<big>HideString</big>** : 隐藏源字符串中的一些字符。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#HideString)]

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

--- a/docs/strutil.md
+++ b/docs/strutil.md
@@ -1284,7 +1284,7 @@ func main() {

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

-<p>HideString hide some chars in source string with param `replaceChar`. replace range is origin[start : end]. [start, end).</p>
+<p>Hide some chars in source string with param `replaceChar`. replace range is origin[start : end]. [start, end).</p>

 <b>Signature:</b>

--- a/docs/strutil_zh-CN.md
+++ b/docs/strutil_zh-CN.md
@@ -56,6 +56,9 @@ import (
 -   [Trim](#Trim)
 -   [SplitAndTrim](#SplitAndTrim)
 -   [HideString](#HideString)
+-   [ContainsAll](#ContainsAll)
+-   [ContainsAny](#ContainsAny)
+

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