test: add example for godoc

README.md

@@ -65,27 +65,22 @@ func main() {
 		FlushTimeout:  time.Second,
 		ErrHandler:    func(err error, t []string) { fmt.Printf("err: %v, ele: %v", err, t) },
 	})
+
 	// data maybe loss if Close() is not be called
 	defer buf.Close()
 
 	// 1. flush at threshold
 	buf.Write("a", "b", "c", "d", "e", "f")
-	// Output
-	// print: [a b c d e f]
 
 	// 2. time to flush automatically
 	buf.Write("aaaaa")
 	buf.Write("bbbbb")
 	buf.Write("ccccc", "ddddd")
 	time.Sleep(5 * time.Second)
-	// Output
-	// print: [aaaaa bbbbb ccccc ddddd]
 
 	// 3. flush manually and write call `WriteWithContext`
 	buf.WriteWithContext(context.Background(), "eeeee", "fffff")
 	buf.Flush()
-	// Output
-	// print: [eeeee fffff]
 }
 
 ```

buffer_test.go

@@ -389,15 +389,3 @@ func TestFlushFunc(t *testing.T) {
 func TestDefaultErrHandler(t *testing.T) {
 	DefaultErrHandler(errors.New("mock_error"), []string{"A", "B", "C"})
 }
-
-// stringInclude return if arr includes v
-func stringInclude(arr []string, v string) bool {
-	b := false
-	for _, item := range arr {
-		if item == v {
-			b = true
-			break
-		}
-	}
-	return b
-}

example_test.go

@@ -0,0 +1,38 @@
+package buffer_test
+
+import (
+	"fmt"
+	"time"
+
+	buffer "github.com/woorui/async-buffer"
+)
+
+// pp implements Flusher interface
+type pp struct{}
+
+func (p *pp) Flush(strs []string) error {
+	return print(strs)
+}
+
+func print(strs []string) error {
+	fmt.Printf("print: %v \n", strs)
+	return nil
+}
+
+func Example() {
+	// can also call buffer.FlushFunc` to adapt a function to Flusher
+	buf := buffer.New[string](&pp{}, buffer.Option[string]{
+		Threshold:     5,
+		FlushInterval: 3 * time.Second,
+		WriteTimeout:  time.Second,
+		FlushTimeout:  time.Second,
+		ErrHandler:    func(err error, t []string) { fmt.Printf("err: %v, ele: %v", err, t) },
+	})
+	// data maybe loss if Close() is not be called
+	defer buf.Close()
+
+	buf.Write("a", "b", "c", "d", "e", "f")
+
+	// Output:
+	// 	print: [a b c d e f]
+}