eventemitter

README

EventEmitter - a simple event emitter

Installation

To install the package, run:

go get github.com/go-zoox/eventemitter

Getting Started

import (
  "testing"
  "github.com/go-zoox/eventemitter"
)

func main(t *testing.T) {
	e := eventemitter.New()
	count := 0
	e.On("send.notify", eventemitter.HandleFunc(func(payload any) {
		count++
		t.Log("send.notify", payload)
	}))

	e.Start()

	wg := &sync.WaitGroup{}
	for i := 0; i < 10; i++ {
		index := i
		wg.Add(1)
		go func() {
			e.Emit("send.notify", index)
			wg.Done()
		}()
	}

	wg.Wait()
}

License

GoZoox is released under the MIT License.

Documentation

Index

• Variables
• type EventEmitter
  • func New(opts ...func(opt *Option)) EventEmitter
• type Handler
  • func HandleFunc(handler func(payload any)) Handler
• type Option

Variables

var Version = "1.4.1"

Version is the current version of the package.

Types

type EventEmitter

type EventEmitter interface {
	On(event string, handler Handler)
	Once(event string, handler Handler)
	Off(event string, handler Handler)
	Emit(event string, payload any)
}

EventEmitter is a simple event emitter.

func New

func New(opts ...func(opt *Option)) EventEmitter

New creates a new EventEmitter.

type Handler

type Handler interface {
	ID() string
	Serve(payload any)
}

Handler is a function that can be registered to an event.

func HandleFunc

func HandleFunc(handler func(payload any)) Handler

HandleFunc creates a Handle from a function.

type Option

type Option struct {
	Context context.Context
	//
	BufferSize int
}

Option is the option for the event emitter.