emitr

README

emitr

Emitr is a simple event emitter library package for Golang.

Features

• Add multiple callback functions
• Group callback functions by name
• Run callback functions by event name
• Add callback functions which are run only once
• Add callback functions which are run on every event

Installation

go get github.com/abcum/emitr

Documentation

Index

• type Emitter
  • func (e *Emitter) Emit(name string)
  • func (e *Emitter) Once(name string, fn func())
  • func (e *Emitter) When(name string, fn func())

Types

type Emitter

type Emitter struct {
	// contains filtered or unexported fields
}

Emitter represents an event emitter.

func (*Emitter) Emit

func (e *Emitter) Emit(name string)

Emit runs callbacks for the specified event name, and ensures that one-off events, are removed when the event has finished emitting.

func (*Emitter) Once

func (e *Emitter) Once(name string, fn func())

Once adds a callback which is called only once when an event is emitted, and then removed immediately after.

func (*Emitter) When

func (e *Emitter) When(name string, fn func())

When adds a callback which is called each and every time that an event is emitted.