feat: add alias AsyncFn for task function.

Author: ghosind

all.go

@@ -14,7 +14,7 @@ import (
 //
 // The index of the function will be -1 if all functions have been completed without error or
 // panic.
-func All(funcs ...func(context.Context) error) (int, error) {
+func All(funcs ...AsyncFn) (int, error) {
 	return all(context.Background(), funcs...)
 }
 
@@ -25,13 +25,13 @@ func All(funcs ...func(context.Context) error) (int, error) {
 //
 // The index of the function will be -1 if all functions have been completed without error or
 // panic, or the context has been canceled (or timeout) before all functions finished.
-func AllWithContext(ctx context.Context, funcs ...func(context.Context) error) (int, error) {
+func AllWithContext(ctx context.Context, funcs ...AsyncFn) (int, error) {
 	return all(ctx, funcs...)
 }
 
 // all executes the functions asynchronously until all functions have been finished, or the context
 // is done (canceled or timeout).
-func all(parent context.Context, funcs ...func(context.Context) error) (int, error) {
+func all(parent context.Context, funcs ...AsyncFn) (int, error) {
 	if len(funcs) == 0 {
 		return -1, nil
 	}
@@ -88,7 +88,7 @@ func all(parent context.Context, funcs ...func(context.Context) error) (int, err
 // AllCompleted executes the functions asynchronously until all functions have been finished. It
 // will return an error slice that is ordered by the functions order, and a boolean value to
 // indicate whether any functions return an error or panic.
-func AllCompleted(funcs ...func(context.Context) error) ([]error, bool) {
+func AllCompleted(funcs ...AsyncFn) ([]error, bool) {
 	return allCompleted(context.Background(), funcs...)
 }
 
@@ -98,7 +98,7 @@ func AllCompleted(funcs ...func(context.Context) error) ([]error, bool) {
 // error or panic.
 func AllCompletedWithContext(
 	ctx context.Context,
-	funcs ...func(context.Context) error,
+	funcs ...AsyncFn,
 ) ([]error, bool) {
 	return allCompleted(ctx, funcs...)
 }
@@ -107,7 +107,7 @@ func AllCompletedWithContext(
 // the context is done (canceled or timeout).
 func allCompleted(
 	parent context.Context,
-	funcs ...func(context.Context) error,
+	funcs ...AsyncFn,
 ) (errs []error, hasError bool) {
 	hasError = false
 	errs = make([]error, len(funcs))

all_test.go

@@ -21,7 +21,7 @@ func TestAllSuccess(t *testing.T) {
 	a := assert.New(t)
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {
@@ -41,7 +41,7 @@ func TestAllFailure(t *testing.T) {
 	a := assert.New(t)
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {
@@ -77,7 +77,7 @@ func TestAllWithTimeoutContext(t *testing.T) {
 	a := assert.New(t)
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {
@@ -109,7 +109,7 @@ func TestAllCompletedSuccess(t *testing.T) {
 	a := assert.New(t)
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {
@@ -131,7 +131,7 @@ func TestAllCompletedPartialFailure(t *testing.T) {
 	errNIs2 := errors.New("n = 2")
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {
@@ -168,7 +168,7 @@ func TestAllCompletedWithTimeoutContext(t *testing.T) {
 	errTimeout := errors.New("timeout")
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {

result.go renamed to async.go

@@ -1,5 +1,11 @@
 package async
 
+import "context"
+
+// AsyncFn is the function to run, it needs to accept a `context.Context` object and return an
+// error object.
+type AsyncFn func(context.Context) error
+
 // executeResult indicates the execution result whether the function returns an error or panic, and
 // the index of the function in the parameters list.
 type executeResult struct {

race.go

@@ -10,20 +10,20 @@ import (
 // Race executes the functions asynchronously, it will return the index and the result of the first
 // of the finished function (including panic), and it will not send a cancel signal to other
 // functions.
-func Race(funcs ...func(context.Context) error) (int, error) {
+func Race(funcs ...AsyncFn) (int, error) {
 	return race(context.Background(), funcs...)
 }
 
 // RaceWithContext executes the functions asynchronously, it will return the index and the result
 // of the first of the finished function (including panic), and it will not send a cancel signal
 // to other functions.
-func RaceWithContext(ctx context.Context, funcs ...func(context.Context) error) (int, error) {
+func RaceWithContext(ctx context.Context, funcs ...AsyncFn) (int, error) {
 	return race(ctx, funcs...)
 }
 
 // race executes the functions asynchronously, it will return the index and the result of the first
 // of the finished function (including panic).
-func race(ctx context.Context, funcs ...func(context.Context) error) (int, error) {
+func race(ctx context.Context, funcs ...AsyncFn) (int, error) {
 	if len(funcs) == 0 {
 		return -1, nil
 	}

race_test.go

@@ -21,7 +21,7 @@ func TestRace(t *testing.T) {
 	a := assert.New(t)
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {
@@ -56,7 +56,7 @@ func TestRaceWithContext(t *testing.T) {
 	a := assert.New(t)
 
 	data := make([]bool, 5)
-	funcs := make([]func(context.Context) error, 0, 5)
+	funcs := make([]AsyncFn, 0, 5)
 	for i := 0; i < 5; i++ {
 		n := i
 		funcs = append(funcs, func(ctx context.Context) error {