Skip to content

Latest commit

 

History

History
97 lines (79 loc) · 2.68 KB

README.md

File metadata and controls

97 lines (79 loc) · 2.68 KB

govents

Govents

Go Reference   Dynamic XML Badge   Go Reference Go Report Card

A small package that implements the NodeJS like Event Emitter API, which provides Node like event constructs in Go with support for generics.

Go 1.18 or newer version is required; the full documentation is at https://pkg.go.dev/github.com/ghoshRitesh12/govents

I think I wrote a banger of an article up at Hashnode; go check it out if interested.

Usage

A basic example:

package main

import (
	"fmt"
	"math/rand"
	"time"

	"github.com/ghoshRitesh12/govents"
)

func main() {
	sample := govents.NewEventEmitter[int]()
	strs := []string{}

	sample.On("data", func(vals ...int) {
		for _, val := range vals {
			strs = append(strs, fmt.Sprintf("v%d", val))
		}
		fmt.Println("within eventListener", strs)
	})

	fmt.Println("outside eventListener", strs)

	for range 4 {
		time.Sleep(time.Second)
		sample.Emit("data", rand.Intn(21), rand.Intn(21), rand.Intn(21))
	}
}

Output for the code above:

outside eventListener []
within eventListener [v12 v10 v11]
within eventListener [v12 v10 v11 v6 v6 v7]
within eventListener [v12 v10 v11 v6 v6 v7 v8 v18 v16]

Some more examples can be found in the example directory.

Detailed documentation of this package can be found in godoc: https://pkg.go.dev/github.com/ghoshRitesh12/govents