hook

package

v0.0.0-...-b5db161 Latest Latest Go to latest Published: May 10, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrStopPropagation = errors.New("event hook propagation stopped")

This section is empty.

type Handler[T any] func(e T) error

type Hook[T any] struct {
	// contains filtered or unexported fields
}

Event hooks store

concurrent safe structure, aka. callbacks propagation

func (h *Hook[T]) Add(fn Handler[T]) string

Append a handler to the hook

func (h *Hook[T]) PreAdd(fn Handler[T]) string

Prepend a handler to the hook

func (h *Hook[T]) Remove(id string)

Remove a single hook handler by its id

func (h *Hook[T]) RemoveAll()

Remove all registered handlers

func (h *Hook[T]) Trigger(data T, oneOffHandlers ...Handler[T]) error

Trigger executes all registered hook handlers one by one with the specified `data` as an argument

Optionally, this method allows also to register additional one off handlers that will be temporary appended to the handlers queue

The execution stops when: - hook.ErrStopPropagation is returned in one of the handlers - any non-nil error is returned in one of the handlers