doc: add doc for new functions of release v2.3.3

2026-02-08 06:32:28 +08:00 · 2024-09-10 14:47:38 +08:00
parent c745097749
commit 84ebc7ce71
14 changed files with 338 additions and 81 deletions
--- a/docs/api/packages/datetime.md
+++ b/docs/api/packages/datetime.md
@@ -1479,7 +1479,7 @@ func main() {
 func TrackFuncTime(pre time.Time) func()
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
@@ -1511,7 +1511,7 @@ func main() {
 func DaysBetween(start, end time.Time) int
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
@@ -1544,7 +1544,7 @@ func main() {
 func GenerateDatetimesBetween(start, end time.Time, layout string, interval string) ([]string, error)
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
--- a/docs/api/packages/function.md
+++ b/docs/api/packages/function.md
@@ -205,7 +205,7 @@ func main() {
 func Debounce(fn func(), delay time.Duration) (debouncedFn func(), cancelFn func())
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
@@ -753,7 +753,7 @@ func main() {
 func Throttle(fn func(), interval time.Duration) func()
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
--- a/docs/api/packages/maputil.md
+++ b/docs/api/packages/maputil.md
@@ -2238,7 +2238,7 @@ func main() {
 func SortByKey[K constraints.Ordered, V any](m map[K]V) (sortedKeysMap map[K]V)
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
--- a/docs/api/packages/random.md
+++ b/docs/api/packages/random.md
@@ -126,7 +126,7 @@ func main() {

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

-<p>从给定切片中随机生成元素</p>
+<p>从给定切片中随机生成元素。</p>

 <b>函数签名:</b>

@@ -134,7 +134,7 @@ func main() {
 func RandFromGivenSlice[T any](slice []T) T
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

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

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

-<p>从给定切片中生成长度为 num 的随机切片</p>
+<p>从给定切片中生成长度为 num 的随机切片。</p>

 <b>函数签名:</b>

@@ -161,7 +161,7 @@ func main() {
 func RandSliceFromGivenSlice[T any](slice []T, num int, repeatable bool) []T
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
@@ -451,7 +451,7 @@ func main() {
 func RandStringSlice(charset string, sliceLen, strLen int) []string
 ```

-<b>实例:</b>
+<b>实例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
@@ -480,7 +480,7 @@ func main() {
 func RandBool() bool
 ```

-<b>实例:</b>
+<b>实例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
@@ -506,7 +506,7 @@ func main() {
 func RandBoolSlice(length int) []bool
 ```

-<b>实例:</b>
+<b>实例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 package main
--- a/docs/api/packages/slice.md
+++ b/docs/api/packages/slice.md
@@ -915,7 +915,7 @@ func main() {
 func FilterConcurrent[T any](slice []T, predicate func(index int, item T) bool, numThreads int) []T
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
@@ -1570,7 +1570,7 @@ func main() {
 func MapConcurrent[T any, U any](slice []T, iteratee func(index int, item T) U, numThreads int) []U
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
@@ -1771,7 +1771,7 @@ func main() {
 func ReduceConcurrent[T any](slice []T, initial T, reducer func(index int, item T, agg T) T, numThreads int) T
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
--- a/docs/api/packages/strutil.md
+++ b/docs/api/packages/strutil.md
@@ -1547,7 +1547,7 @@ func main() {
 func Concat(length int, str ...string) string
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
@@ -1581,7 +1581,7 @@ func main() {
 func Ellipsis(str string, length int) string
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
@@ -1615,7 +1615,7 @@ func main() {
 func Shuffle(str string) string
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
@@ -1639,7 +1639,7 @@ func main() {
 func Rotate(str string, shift int) string
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
@@ -1665,7 +1665,7 @@ func main() {

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

-<p>将模板字符串中的占位符替换为数据映射中的相应值。占位符括在花括号中，例如 {key}。例如，模板字符串为“Hello, {name}!”，数据映射为{"name": "world"}，结果将为“Hello, world!”。</p>
+<p>将模板字符串中的占位符替换为map中的相应值。占位符括在花括号中，例如 {key}。例如，模板字符串为“Hello, {name}!”，map为{"name": "world"}，结果将为“Hello, world!”。</p>

 <b>函数签名:</b>

@@ -1707,7 +1707,7 @@ func main() {
 func RegexMatchAllGroups(pattern, str string) [][]string
 ```

-<b>示例:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
--- a/docs/en/api/packages/datetime.md
+++ b/docs/en/api/packages/datetime.md
@@ -1480,7 +1480,7 @@ func main() {
 func TrackFuncTime(pre time.Time) func()
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1512,7 +1512,7 @@ func main() {
 func DaysBetween(start, end time.Time) int
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1545,7 +1545,7 @@ func main() {
 func GenerateDatetimesBetween(start, end time.Time, layout string, interval string) ([]string, error)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
--- a/docs/en/api/packages/function.md
+++ b/docs/en/api/packages/function.md
@@ -204,7 +204,7 @@ func main() {
 func Debounce(fn func(), delay time.Duration) (debouncedFn func(), cancelFn func())
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -752,7 +752,7 @@ func main() {
 func Throttle(fn func(), interval time.Duration) func()
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
--- a/docs/en/api/packages/maputil.md
+++ b/docs/en/api/packages/maputil.md
@@ -77,6 +77,8 @@ import (
 -   [ConcurrentMap_Has](#ConcurrentMap_Has)
 -   [ConcurrentMap_Range](#ConcurrentMap_Range)
 -   [GetOrSet](#GetOrSet)
+-   [SortByKey](#SortByKey)
+

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

@@ -1165,7 +1167,7 @@ func main() {
 func NewOrderedMap[K comparable, V any]() *OrderedMap[K, V]
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1204,7 +1206,7 @@ func main() {
 func (om *OrderedMap[K, V]) Set(key K, value V)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1243,7 +1245,7 @@ func main() {
 func (om *OrderedMap[K, V]) Get(key K) (V, bool)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1283,7 +1285,7 @@ func main() {
 func (om *OrderedMap[K, V]) Delete(key K)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1319,7 +1321,7 @@ func main() {
 func (om *OrderedMap[K, V]) Clear()
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1358,7 +1360,7 @@ func (om *OrderedMap[K, V]) Front() (struct {
 }, bool)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1398,7 +1400,7 @@ func (om *OrderedMap[K, V]) Back() (struct {
 }, bool)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1435,7 +1437,7 @@ func main() {
 func (om *OrderedMap[K, V]) Range(iteratee func(key K, value V) bool)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1474,7 +1476,7 @@ func main() {
 func (om *OrderedMap[K, V]) Keys() []K
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1510,7 +1512,7 @@ func main() {
 func (om *OrderedMap[K, V]) Values() []V
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1546,7 +1548,7 @@ func main() {
 func (om *OrderedMap[K, V]) Elements() []struct
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1582,7 +1584,7 @@ func main() {
 func (om *OrderedMap[K, V]) Len() int
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1618,7 +1620,7 @@ func main() {
 func (om *OrderedMap[K, V]) Contains(key K) bool
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1660,7 +1662,7 @@ func (om *OrderedMap[K, V]) Iter() <-chan struct {
 }
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1739,7 +1741,7 @@ func main() {
 func (om *OrderedMap[K, V]) SortByKey(less func(a, b K) bool)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1778,7 +1780,7 @@ func main() {
 func (om *OrderedMap[K, V]) MarshalJSON() ([]byte, error)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -1815,7 +1817,7 @@ func main() {
 func (om *OrderedMap[K, V]) UnmarshalJSON(data []byte) error
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -2254,7 +2256,7 @@ func main() {
 func SortByKey[K constraints.Ordered, V any](m map[K]V) (sortedKeysMap map[K]V)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
--- a/docs/en/api/packages/random.md
+++ b/docs/en/api/packages/random.md
@@ -133,7 +133,7 @@ func main() {
 func RandFromGivenSlice[T any](slice []T) T
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -160,7 +160,7 @@ func main() {
 func RandSliceFromGivenSlice[T any](slice []T, num int, repeatable bool) []T
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -346,7 +346,7 @@ func main() {
 func RandIntSlice(length, min, max int) []int
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -452,7 +452,7 @@ func main() {
 func RandStringSlice(charset string, sliceLen, strLen int) []string
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -481,7 +481,7 @@ func main() {
 func RandBool() bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
@@ -507,7 +507,7 @@ func main() {
 func RandBoolSlice(length int) []bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 package main
--- a/docs/en/api/packages/slice.md
+++ b/docs/en/api/packages/slice.md
@@ -913,7 +913,7 @@ func main() {
 func FilterConcurrent[T any](slice []T, predicate func(index int, item T) bool, numThreads int) []T
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
@@ -1190,7 +1190,7 @@ func main() {
 func ForEachConcurrent[T any](slice []T, iteratee func(index int, item T), numThreads int)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
@@ -1766,7 +1766,7 @@ func main() {
 func ReduceConcurrent[T any](slice []T, initial T, reducer func(index int, item T, agg T) T, numThreads int) T
 ```

-<b>Example:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[运行](todo)</span></b>

 ```go
 import (
@@ -2962,7 +2962,7 @@ func main() {
 func Frequency[T comparable](slice []T) map[T]int
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
--- a/docs/en/api/packages/strutil.md
+++ b/docs/en/api/packages/strutil.md
@@ -1549,7 +1549,7 @@ func main() {
 func Concat(length int, str ...string) string
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
@@ -1582,7 +1582,7 @@ func main() {
 func Ellipsis(str string, length int) string
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
@@ -1616,7 +1616,7 @@ func main() {
 func Shuffle(str string) string
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
@@ -1640,7 +1640,7 @@ func main() {
 func Rotate(str string, shift int) string
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
@@ -1673,7 +1673,7 @@ func main() {
 func TemplateReplace(template string, data map[string]string string
 ```

-<b>example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (
@@ -1707,7 +1707,7 @@ func main() {
 func RegexMatchAllGroups(pattern, str string) [][]string
 ```

-<b>example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>

 ```go
 import (