doc: add document for pipeline

docs/datetime.md

@@ -251,7 +251,7 @@ func main() {
 <b>Signature:</b>
 
 ```go
-func BeginOfWeek(t time.Time) time.Time
+func BeginOfWeek(t time.Time, beginFrom ...time.Weekday) time.Time
 ```
 <b>Example:</b>
 
@@ -414,7 +414,7 @@ func main() {
 <b>Signature:</b>
 
 ```go
-func EndOfWeek(t time.Time) time.Time
+func EndOfWeek(t time.Time, endWith ...time.Weekday) time.Time
 ```
 <b>Example:</b>
 

docs/datetime_zh-CN.md

@@ -243,12 +243,12 @@ func main() {
 
 
 ### <span id="BeginOfWeek">BeginOfWeek</span>
-<p>返回指定时间的星期开始时间</p>
+<p>返回指定时间的每周开始时间,默认开始时间星期日</p>
 
 <b>函数签名:</b>
 
 ```go
-func BeginOfWeek(t time.Time) time.Time
+func BeginOfWeek(t time.Time, beginFrom ...time.Weekday) time.Time
 ```
 <b>例子:</b>
 
@@ -406,12 +406,12 @@ func main() {
 
 
 ### <span id="EndOfWeek">EndOfWeek</span>
-<p>返回指定时间的星期结束时间</p>
+<p>返回指定时间的星期结束时间,默认结束时间星期六</p>
 
 <b>函数签名:</b>
 
 ```go
-func EndOfWeek(t time.Time) time.Time
+func EndOfWeek(t time.Time, endWith ...time.Weekday) time.Time
 ```
 <b>例子:</b>
 

docs/function.md

@@ -26,6 +26,7 @@ import (
 - [Compose](#Compose)
 - [Debounced](#Debounced)
 - [Delay](#Delay)
+- [Pipeline](#Pipeline)
 - [Watcher](#Watcher)
 
 <div STYLE="page-break-after: always;"></div>
@@ -300,6 +301,43 @@ func main() {
 ```
 
 
+### <span id="Pipeline">Pipeline</span>
+
+<p>Pipeline takes a list of functions and returns a function whose param will be passed into
+the functions one by one.</p>
+
+<b>Signature:</b>
+
+```go
+func Pipeline[T any](funcs ...func(T) T) func(T) T
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/function"
+)
+
+func main() {
+    addOne := func(x int) int {
+		return x + 1
+	}
+	double := func(x int) int {
+		return 2 * x
+	}
+	square := func(x int) int {
+		return x * x
+	}
+
+	f := Pipeline(addOne, double, square)
+
+	fmt.Println(f(2)) //36
+}
+```
+
 
 ### <span id="Watcher">Watcher</span>
 

docs/function_zh-CN.md

@@ -26,6 +26,7 @@ import (
 - [Compose](#Compose)
 - [Debounced](#Debounced)
 - [Delay](#Delay)
+- [Pipeline](#Pipeline)
 - [Watcher](#Watcher)
 
 <div STYLE="page-break-after: always;"></div>
@@ -300,6 +301,44 @@ func main() {
 
 
 
+### <span id="Pipeline">Pipeline</span>
+
+<p>执行函数pipeline.</p>
+
+<b>函数签名:</b>
+
+```go
+func Pipeline[T any](funcs ...func(T) T) func(T) T
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/function"
+)
+
+func main() {
+    addOne := func(x int) int {
+		return x + 1
+	}
+	double := func(x int) int {
+		return 2 * x
+	}
+	square := func(x int) int {
+		return x * x
+	}
+
+	f := Pipeline(addOne, double, square)
+
+	fmt.Println(f(2)) //36
+}
+```
+
+
+
 ### <span id="Watcher">Watcher</span>
 
 <p>Watcher 用于记录代码执行时间。可以启动/停止/重置手表定时器。获取函数执行的时间。 </p>

function/function.go

@@ -113,3 +113,15 @@ func Schedule(d time.Duration, fn any, args ...any) chan bool {
 
 	return quit
 }
+
+// Pipeline takes a list of functions and returns a function whose param will be passed into
+// the functions one by one.
+func Pipeline[T any](funcs ...func(T) T) func(T) T {
+	return func(arg T) (result T) {
+		result = arg
+		for _, fn := range funcs {
+			result = fn(result)
+		}
+		return
+	}
+}

function/function_test.go

@@ -134,3 +134,21 @@ func TestSchedule(t *testing.T) {
 	// expected := []string{"*", "*", "*", "*", "*"}
 	// assert.Equal(expected, res)
 }
+
+func TestPipeline(t *testing.T) {
+	assert := internal.NewAssert(t, "TestPipeline")
+
+	addOne := func(x int) int {
+		return x + 1
+	}
+	double := func(x int) int {
+		return 2 * x
+	}
+	square := func(x int) int {
+		return x * x
+	}
+
+	f := Pipeline(addOne, double, square)
+
+	assert.Equal(36, f(2))
+}

function/watcher_test.go

@@ -1,6 +1,7 @@
 package function
 
 import (
+	"fmt"
 	"testing"
 
 	"github.com/duke-git/lancet/v2/internal"
@@ -34,4 +35,5 @@ func longRunningTask() {
 	for i := 0; i < 10000000; i++ {
 		slice = append(slice, int64(i))
 	}
+	fmt.Println(slice)
 }