zishuo/event
1
0
Fork 0
mirror of https://github.com/gookit/event synced 2025-09-26 19:11:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

📝 chore: update some readme and some code comments

Browse Source
This commit is contained in:
inhere
2025-08-25 13:19:22 +08:00
parent 2139003c0e
commit 01c5d2e33e
5 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -1,7 +1,7 @@
# Event # Event
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/gookit/event?style=flat-square) ![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) [![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) [![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) [![Go Report Card](https://goreportcard.com/badge/github.com/gookit/event)](https://goreportcard.com/report/github.com/gookit/event)

2
README.zh-CN.md
View File

@@ -1,7 +1,7 @@
# Event # Event
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/gookit/event?style=flat-square) ![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) [![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) [![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) [![Go Report Card](https://goreportcard.com/badge/github.com/gookit/event)](https://goreportcard.com/report/github.com/gookit/event)

6
manager.go
View File

@@ -79,17 +79,17 @@ func (em *Manager) WithOptions(fns ...OptionFn) *Manager {
* region Register listeners * 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) { func (em *Manager) AddListener(name string, listener Listener, priority ...int) {
em.On(name, listener, priority...) 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) { func (em *Manager) Listen(name string, listener Listener, priority ...int) {
em.On(name, listener, priority...) 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) { func (em *Manager) Once(name string, listener Listener, priority ...int) {
var listenerOnce Listener var listenerOnce Listener
listenerOnce = ListenerFunc(func(e Event) error { listenerOnce = ListenerFunc(func(e Event) error {

5
manager_fire.go
View File

@@ -4,6 +4,8 @@ import (
"context" "context"
"fmt" "fmt"
"strings" "strings"
"github.com/gookit/goutil/x/basefn"
) )
/************************************************************* /*************************************************************
@@ -337,6 +339,9 @@ func (em *Manager) AwaitFire(e Event) (err error) {
* region Helper methods * 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. // CloseWait close channel and wait all async event done.
func (em *Manager) CloseWait() error { func (em *Manager) CloseWait() error {
if err := em.Close(); err != nil { if err := em.Close(); err != nil {

2
std.go
View File

@@ -22,7 +22,7 @@ func On(name string, listener Listener, priority ...int) {
std.On(name, listener, priority...) 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) { func Once(name string, listener Listener, priority ...int) {
std.Once(name, listener, priority...) std.Once(name, listener, priority...)
} }