doc: add examples.

Author: ghosind

retry_test.go

@@ -3,6 +3,7 @@ package async
 import (
 	"context"
 	"errors"
+	"fmt"
 	"testing"
 	"time"
 
@@ -136,3 +137,23 @@ func TestRetryWithContext(t *testing.T) {
 	a.NilNow(err)
 	a.EqualNow(out, []any{1, nil})
 }
+
+func ExampleRetry() {
+	i := 0
+
+	out, err := Retry(func() error {
+		i++
+		if i != 3 {
+			return errors.New("i != 3")
+		} else {
+			return nil
+		}
+	})
+	fmt.Println(i)
+	fmt.Println(out)
+	fmt.Println(err)
+	// Outputs:
+	// 3
+	// [<nil>]
+	// <nil>
+}

until_test.go

@@ -3,6 +3,7 @@ package async
 import (
 	"context"
 	"errors"
+	"fmt"
 	"testing"
 	"time"
 
@@ -108,3 +109,21 @@ func TestUntilWithContext(t *testing.T) {
 	a.GteNow(dur, 100*time.Millisecond)
 	a.LteNow(dur, 150*time.Millisecond)
 }
+
+func ExampleUntil() {
+	i := 0
+
+	out, err := Until(func(n int) bool {
+		return n < 3
+	}, func() int {
+		i++
+		return i
+	})
+	fmt.Println(i)
+	fmt.Println(out)
+	fmt.Println(err)
+	// Outputs:
+	// 3
+	// [3]
+	// <nil>
+}

while_test.go

@@ -3,6 +3,7 @@ package async
 import (
 	"context"
 	"errors"
+	"fmt"
 	"testing"
 	"time"
 
@@ -98,3 +99,20 @@ func TestWhileWithContext(t *testing.T) {
 	a.GteNow(dur, 100*time.Millisecond)
 	a.LteNow(dur, 150*time.Millisecond)
 }
+
+func ExampleWhile() {
+	i := 0
+
+	out, err := While(func() bool {
+		return i < 3
+	}, func() {
+		i++
+	})
+	fmt.Println(i)
+	fmt.Println(out)
+	fmt.Println(err)
+	// Outputs:
+	// 3
+	// []
+	// <nil>
+}