doc: add play ground demo

2026-02-09 15:12:26 +08:00 · 2024-10-09 16:56:56 +08:00
parent 5d6ab72059
commit 213e2b4ead
30 changed files with 293 additions and 275 deletions
--- a/docs/en/api/packages/cryptor.md
+++ b/docs/en/api/packages/cryptor.md
@@ -391,7 +391,7 @@ func main() {
 func AesGcmEncrypt(data, key []byte) []byte
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/rUt0-DmsPCs)</span></b>

 ```go
 package main
@@ -425,7 +425,7 @@ func main() {
 func AesGcmDecrypt(data, key []byte) []byte
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/rUt0-DmsPCs)</span></b>

 ```go
 package main
--- 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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/QBSEdfXHPTp)</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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/qD6qGb3TbOy)</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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/6kHBpAxD9ZC)</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:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/-dGFrYn_1Zi)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/HpoMov-tJSN)</span></b>

 ```go
 package main
--- a/docs/en/api/packages/maputil.md
+++ b/docs/en/api/packages/maputil.md
@@ -1167,7 +1167,7 @@ func main() {
 func NewOrderedMap[K comparable, V any]() *OrderedMap[K, V]
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/99QjSYSBdiM)</span></b>

 ```go
 package main
@@ -1206,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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/Y4ZJ_oOc1FU)</span></b>

 ```go
 package main
@@ -1245,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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/Y4ZJ_oOc1FU)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/5bIi4yaZ3K-)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/8LwoJyEfuFr)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/ty57XSimpoe)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/rQMjp1yQmpa)</span></b>

 ```go
 package main
@@ -1417,12 +1417,12 @@ func main() {
    om.Set("b", 2)
    om.Set("c", 3)

-    frontElement, ok := om.Front()
-    fmt.Println(frontElement)
+    backElement, ok := om.Back()
+    fmt.Println(backElement)
    fmt.Println(ok)

    // Output:
-    // {a 1}
+    // {c 3}
    // true
 }
 ```
@@ -1437,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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/U-KpORhc7LZ)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/Vv_y9ExKclA)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/TWj5n1-PUfx)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/4BHG4kKz6bB)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/cLe6z2VX5N-)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/QuwqqnzwDNX)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/tlq2tdvicPt)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run]()</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/8Q0ssg6hZzO)</span></b>

 ```go
 package main
@@ -1741,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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/N7hjD_alZPq)</span></b>

 ```go
 package main
@@ -1752,7 +1752,7 @@ import (
 )

 func main() {
-    om := maputil.NewOrderedMap[string, int]()
+    om := maputil.NewOrderedMap[int, string]()

    om.Set(3, "c")
    om.Set(1, "a")
@@ -1780,7 +1780,7 @@ func main() {
 func (om *OrderedMap[K, V]) MarshalJSON() ([]byte, error)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/C-wAwydIAC7)</span></b>

 ```go
 package main
@@ -1791,7 +1791,7 @@ import (
 )

 func main() {
-    om := maputil.NewOrderedMap[string, int]()
+    om := maputil.NewOrderedMap[int, string]()

    om.Set(3, "c")
    om.Set(1, "a")
@@ -1817,7 +1817,7 @@ func main() {
 func (om *OrderedMap[K, V]) UnmarshalJSON(data []byte) error
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/8C3MvJ3-mut)</span></b>

 ```go
 package main
@@ -1837,6 +1837,7 @@ func main() {
    fmt.Println(om.Elements())

    // Output:
+    // [{a 1} {b 2} {c 3}] 
 }
 ```

@@ -2256,7 +2257,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;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/PVdmBSnm6P_W)</span></b>

 ```go
 package main
@@ -2274,7 +2275,9 @@ func main() {
        2: "b",
    }

-    result := maputil.SortByKey(m)
+    result := maputil.SortByKey(m, func(a, b int) bool {
+		return a < b
+	})

    fmt.Println(result)

@@ -2293,7 +2296,7 @@ func main() {
 func GetOrDefault[K comparable, V any](m map[K]V, key K, defaultValue V) V 
 ```

-<b>Example:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/99QjSYSBdiM)</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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/UrkWueF6yYo)</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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/68UikN9d6VT)</span></b>

 ```go
 package main
@@ -171,8 +171,10 @@ import (
 )

 func main() {
-    	goods := []string{"apple", "banana", "cherry", "elderberry", "fig", "grape", "honeydew", "kiwi", "lemon", "mango", "nectarine", "orange"}
-	chosen3goods := random.RandSliceFromGivenSlice(goods, 3, false)
+    goods := []string{"apple", "banana", "cherry", "elderberry", "fig", "grape", "honeydew", "kiwi", "lemon", "mango", "nectarine", "orange"}
+	
+    chosen3goods := random.RandSliceFromGivenSlice(goods, 3, false)
+
 	fmt.Println(chosen3goods)
 }
 ```
@@ -346,7 +348,7 @@ func main() {
 func RandIntSlice(length, min, max int) []int
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/GATTQ5xTEG8)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/2_-PiDv3tGn)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/to6BLc26wBv)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/o-VSjPjnILI)</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:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/t_pkwerIRVx)</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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/kT4XW7DKVoV)</span></b>

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

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/H1ehfPkPen0)</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;">[运行](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/Tjwe6OtaG07)</span></b>

 ```go
 import (
@@ -2445,7 +2445,7 @@ func main() {
 func UniqueBy[T any, U comparable](slice []T, iteratee func(item T) U) []T
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/UR323iZLDpv)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/GY7JE4yikrl)</span></b>

 ```go
 import (
@@ -2476,7 +2476,7 @@ func main() {
 func UniqueByComparator[T comparable](slice []T, comparator func(item T, other T) bool) []T
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/rwSacr-ZHsR)</span></b>

 ```go
 import (
@@ -2512,7 +2512,7 @@ func main() {
 func UniqueByConcurrent[T comparable](slice []T, comparator func(item T, other T) bool, numThreads int) []T
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Runs](https://go.dev/play/p/wXZ7LcYRMGL)</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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/CW3UVNdUZOq)</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](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/gD52SZHr4Kp)</span></b>

 ```go
 import (
@@ -1561,6 +1561,7 @@ func main() {
    result1 := strutil.Concat(12, "Hello", " ", "World", "!")
    result2 := strutil.Concat(11, "Go", " ", "Language")
    result3 := strutil.Concat(0, "An apple a ", "day，", "keeps the", " doctor away")
+    
    fmt.Println(result1)
    fmt.Println(result2)
    fmt.Println(result3)
@@ -1582,7 +1583,7 @@ func main() {
 func Ellipsis(str string, length int) string
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/i1vbdQiQVRR)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/iStFwBwyGY7)</span></b>

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

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/Kf03iOeT5bd)</span></b>

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

-<b>example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/cXSuFvyZqv9)</span></b>

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

-<b>example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/JZiu0RXpgN-)</span></b>

 ```go
 import (
--- a/docs/en/api/packages/system.md
+++ b/docs/en/api/packages/system.md
@@ -325,7 +325,7 @@ func main() {
 func StartProcess(command string, args ...string) (int, error)
 ```

-<b>Example:<span style="float:right;display:inline-block">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block">[Run](https://go.dev/play/p/5GVol6ryS_X)</span></b>

 ```go
 import (
@@ -353,7 +353,7 @@ func main() {
 func StopProcess(pid int) error
 ```

-<b>Example:<span style="float:right;display:inline-block">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block">[Run](https://go.dev/play/p/jJZhRYGGcmD)</span></b>

 ```go
 import (
@@ -387,7 +387,7 @@ func main() {
 func KillProcess(pid int) error
 ```

-<b>Example:<span style="float:right;display:inline-block">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block">[Run](https://go.dev/play/p/XKmvV-ExBWa)</span></b>

 ```go
 import (
@@ -421,7 +421,7 @@ func main() {
 func GetProcessInfo(pid int) (*ProcessInfo, error)
 ```

-<b>Example:<span style="float:right;display:inline-block">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block">[Run](https://go.dev/play/p/NQDVywEYYx7)</span></b>

 ```go
 import (