emitter-kit v5.2.2
A replacement for NSNotificationCenter#addObserver and NSObject#addObserver that is type-safe and not verbose.
import EmitterKit
// A generic event emitter (but type-safe)!
var event = Event<T>()
// Any emitted data must be the correct type.
event.emit(data)
// This listener will only be called once.
// You are *not* required to retain it.
event.once { data: T in
print(data)
}
// This listener won't stop listening;
// unless you stop it manually,
// or its Event<T> is deallocated.
// You *are* required to retain it.
var listener = event.on { data: T in
print(data)
}
// Stop the listener manually.
listener.isListening = false
// Restart the listener (if it was stopped).
listener.isListening = true
Targeting
A target allows you to associate a specific AnyObject with an emit call. This is useful when emitting events associated with classes you can't add properties to (like UIView).
When calling emit with a target, you must also call on or once with the same target in order to receive the emitted event.
let myView = UIView()
let didTouch = Event<UITouch>()
didTouch.once(myView) { touch in
print(touch)
}
didTouch.emit(myView, touch)
NSNotification
The Notifier class helps when you are forced to use NSNotificationCenter (for example, if you want to know when the keyboard has appeared).
// You are **not** required to retain this after creating your listener.
var event = Notifier(UIKeyboardWillShowNotification)
// Handle NSNotifications with style!
listener = event.on { (notif: Notification) in
print(notif.userInfo)
}
Key-Value Observation (KVO)
// Any NSObject descendant will work.
var view = UIView()
// "Make KVO great again!" - Donald Trump
listener = view.on("bounds") { (change: Change<CGRect>) in
print(change)
}
Thread Safety
The following actions must be done on the same thread, or you need manual locking:
- Emit an event
- Add/remove a listener
- Set the
isListeningproperty of a listener
v5.2.2 changelog
- Fixed protocol casting (#60)
v5.2.1 changelog
- Fix Carthage compatibility for non iOS platforms
v5.2.0 changelog
- Added the
Event.getListenersmethod - Listeners are now always called in the order they were added
- Event.emit() can be called without an argument
- Carthage support has been improved
v5.1.0 changelog
-
The
NotificationListenerclass now takes aNotificationinstead of anNSDictionary. -
A
NotificationListenerwithout a target will now receive everyNotificationwith its name, regardless of the value ofnotif.object.
v5.0.0 changelog
-
Swift 3.0 + Xcode 8.0 beta 6 support
-
The
Signalclass was removed. (useEvent<Void>instead) -
The
Emitterabstract class was removed. -
The
EmitterListenerclass was renamedEventListener<T>. -
The
Event<T>class no longer has a superclass. -
The
Notificationclass was renamedNotifier(to prevent collision withFoundation.Notification). -
The
onandoncemethods ofEvent<T>now return anEventListener<T>(instead of just aListener) -
The
onandoncemethods ofNotifiernow return anNotificationListener(instead of just aListener) -
The
onandoncemethods ofNSObjectnow return anChangeListener<T>(instead of just aListener) -
The
keyPath,options, andobjectproperties ofChangeListener<T>are now public. -
A
listenerCount: Intcomputed property was added to theEvent<T>class. -
An
event: Event<T>property was added to theEventListener<T>class.
The changelog for older versions can be found here.
708 Jun 29, 2022
147 Nov 24, 2022
55 Nov 29, 2021
4 Oct 5, 2022
4.2k Jan 5, 2023
1.9k Dec 20, 2022
40 Sep 23, 2022
759 Dec 2, 2022
2.2k Jan 1, 2023
77 Feb 18, 2022
368 Nov 9, 2022
2.5k Dec 28, 2022
7.3k Jan 9, 2023
179 Nov 21, 2022
115 Nov 23, 2022
324 Dec 17, 2022
259 Dec 29, 2022
160 Dec 25, 2022
1.9k Dec 30, 2022
12 Jul 19, 2022