From 01c5d2e33ec7ef6167b601f757381184c10c4722 Mon Sep 17 00:00:00 2001 From: inhere Date: Mon, 25 Aug 2025 13:19:22 +0800 Subject: [PATCH] :memo: chore: update some readme and some code comments --- README.md | 2 +- README.zh-CN.md | 2 +- manager.go | 6 +++--- manager_fire.go | 5 +++++ std.go | 2 +- 5 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 71e89fe..8780fa2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Event ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/gookit/event?style=flat-square) -[![GoDoc](https://godoc.org/github.com/gookit/event?status.svg)](https://pkg.go.dev/github.com/gookit/event) +[![GoDoc](https://pkg.go.dev/badge/github.com/gookit/event.svg)](https://pkg.go.dev/github.com/gookit/event) [![Actions Status](https://github.com/gookit/event/workflows/Unit-Tests/badge.svg)](https://github.com/gookit/event/actions) [![Coverage Status](https://coveralls.io/repos/github/gookit/event/badge.svg?branch=master)](https://coveralls.io/github/gookit/event?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/gookit/event)](https://goreportcard.com/report/github.com/gookit/event) diff --git a/README.zh-CN.md b/README.zh-CN.md index 1dbcc3b..0e96c84 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,7 +1,7 @@ # Event ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/gookit/event?style=flat-square) -[![GoDoc](https://godoc.org/github.com/gookit/event?status.svg)](https://pkg.go.dev/github.com/gookit/event) +[![GoDoc](https://pkg.go.dev/badge/github.com/gookit/event.svg)](https://pkg.go.dev/github.com/gookit/event) [![Actions Status](https://github.com/gookit/event/workflows/Unit-Tests/badge.svg)](https://github.com/gookit/event/actions) [![Coverage Status](https://coveralls.io/repos/github/gookit/event/badge.svg?branch=master)](https://coveralls.io/github/gookit/event?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/gookit/event)](https://goreportcard.com/report/github.com/gookit/event) diff --git a/manager.go b/manager.go index 4e0e27a..6e6b1d4 100644 --- a/manager.go +++ b/manager.go @@ -79,17 +79,17 @@ func (em *Manager) WithOptions(fns ...OptionFn) *Manager { * region Register listeners *************************************************************/ -// AddListener register a event handler/listener. alias of the method On() +// AddListener register an event handler/listener. alias of the method On() func (em *Manager) AddListener(name string, listener Listener, priority ...int) { em.On(name, listener, priority...) } -// Listen register a event handler/listener. alias of the On() +// Listen register an event handler/listener. alias of the On() func (em *Manager) Listen(name string, listener Listener, priority ...int) { em.On(name, listener, priority...) } -// Listen register a event handler/listener. trigger once. +// Once register an event handler/listener. trigger once. func (em *Manager) Once(name string, listener Listener, priority ...int) { var listenerOnce Listener listenerOnce = ListenerFunc(func(e Event) error { diff --git a/manager_fire.go b/manager_fire.go index e40268d..8b02968 100644 --- a/manager_fire.go +++ b/manager_fire.go @@ -4,6 +4,8 @@ import ( "context" "fmt" "strings" + + "github.com/gookit/goutil/x/basefn" ) /************************************************************* @@ -337,6 +339,9 @@ func (em *Manager) AwaitFire(e Event) (err error) { * region Helper methods *************************************************************/ +// MustCloseWait close channel and wait all async event done. panic if error +func (em *Manager) MustCloseWait() { basefn.PanicErr(em.CloseWait()) } + // CloseWait close channel and wait all async event done. func (em *Manager) CloseWait() error { if err := em.Close(); err != nil { diff --git a/std.go b/std.go index a08929d..b3654cd 100644 --- a/std.go +++ b/std.go @@ -22,7 +22,7 @@ func On(name string, listener Listener, priority ...int) { std.On(name, listener, priority...) } -// On register a listener to the event. trigger once +// Once register a listener to the event. trigger once func Once(name string, listener Listener, priority ...int) { std.Once(name, listener, priority...) }