events

Documentation

Overview

Source: https://github.com/kataras/go-events Package events provides simple EventEmitter support for Go Programming Language

Index

• Constants
• type EventEmitter
  • func New() EventEmitter
• type EventName
• type Events
• type Listener

Examples

• Events

Constants

const (
	// Version current version number
	Version = types.EventVersion
	// DefaultMaxListeners is the number of max listeners per event
	// default EventEmitters will print a warning if more than x listeners are
	// added to it. This is a useful default which helps finding memory leaks.
	// Defaults to 0, which means unlimited
	DefaultMaxListeners = types.EventDefaultMaxListeners
)

Types

type EventEmitter

type EventEmitter = types.EventEmitter

EventEmitter is the message/or/event manager

func New

func New() EventEmitter

New returns a new, empty, EventEmitter

type EventName

type EventName = types.EventName

EventName is just a type of string, it's the event name

type Events

type Events = types.Events

Events the type for registered listeners, it's just a map[string][]func(...any)

Example

// regiter our events to the default event emmiter
for evt, listeners := range testEvents {
	_event.On(evt, listeners...)
}

user := "user1"
room := "room1"

createUser(user)
joinUserTo(user, room)
leaveFromRoom(user, room)

Output:

A new User just created!
A new User just created, *from second event listener
user1 joined to room: room1
user1 left from the room: room1

type Listener

type Listener = types.Listener

Listener is the type of a Listener, it's a func which receives any,optional, arguments from the caller/emmiter