events

Documentation

Overview

Package events provides a simple event emitter.

Index

• type Emitter
  • func NewEmitter() *Emitter
  • func (emitter *Emitter) Emit(event any, arguments ...any)
  • func (emitter *Emitter) On(event, listener any) (cancel func())
  • func (emitter *Emitter) Once(event, listener any) (cancel func())

Types

type Emitter

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

Emitter is a simple event emitter. This is a thin wrapper of emission.Emitter that modifies emitter.On method to return a function that cancels the callback registration.

func NewEmitter

func NewEmitter() *Emitter

NewEmitter creates a simple event emitter.

func (*Emitter) Emit

func (emitter *Emitter) Emit(event any, arguments ...any)

Emit triggers an event.

func (*Emitter) On

func (emitter *Emitter) On(event, listener any) (cancel func())

On registers a callback when an event occurs. Returns a function that cancels the callback registration.

func (*Emitter) Once

func (emitter *Emitter) Once(event, listener any) (cancel func())

Once registers a one-time callback when an event occurs. Returns a function that cancels the callback registration.