updated code comments and added some notes

This commit is contained in:
Gani Georgiev
2023-06-19 21:45:45 +03:00
parent a7bb599cd0
commit c0a6a21b9e
7 changed files with 110 additions and 103 deletions
+2
View File
@@ -57,6 +57,7 @@ func (h *Hook[T]) Add(fn Handler[T]) string {
return id
}
// @todo add also to TaggedHook
// Remove removes a single hook handler by its id.
func (h *Hook[T]) Remove(id string) {
h.mux.Lock()
@@ -70,6 +71,7 @@ func (h *Hook[T]) Remove(id string) {
}
}
// @todo add also to TaggedHook
// RemoveAll removes all registered handlers.
func (h *Hook[T]) RemoveAll() {
h.mux.Lock()
+4 -4
View File
@@ -50,8 +50,8 @@ func (h *TaggedHook[T]) CanTriggerOn(tags []string) bool {
// PreAdd registers a new handler to the hook by prepending it to the existing queue.
//
// The fn handler will be called only if the event data tags satisfy h.CanTriggerOn.
func (h *TaggedHook[T]) PreAdd(fn Handler[T]) {
h.mainHook.PreAdd(func(e T) error {
func (h *TaggedHook[T]) PreAdd(fn Handler[T]) string {
return h.mainHook.PreAdd(func(e T) error {
if h.CanTriggerOn(e.Tags()) {
return fn(e)
}
@@ -63,8 +63,8 @@ func (h *TaggedHook[T]) PreAdd(fn Handler[T]) {
// Add registers a new handler to the hook by appending it to the existing queue.
//
// The fn handler will be called only if the event data tags satisfy h.CanTriggerOn.
func (h *TaggedHook[T]) Add(fn Handler[T]) {
h.mainHook.Add(func(e T) error {
func (h *TaggedHook[T]) Add(fn Handler[T]) string {
return h.mainHook.Add(func(e T) error {
if h.CanTriggerOn(e.Tags()) {
return fn(e)
}