events_emitter 0.6.0

events_emitter: ^0.6.0 copied to clipboard

[!] Changed:

• Dart SDK constraint updated from <3.0.0 to <4.0.0
• Dependency rxdart updated from 0.27.5 to 0.28.0

Added:

• RestrictedEventEmitter for better control by allowing or disallowing specific event types, and the max listeners limit.
• ListCallback.args1() to get the first argument of the list in a callback, added for consistency

Changed:

• Data property in .emit() is optional, if no data is given the event will be of type Event<Null> which can still be caught by EventCallback<dynamic>

Fixed:

• Replaced lint developer dependency with lints

Added:

• ListCallback, a helper class that when appended on .on() lets you have multiple arguments. Essentially splitting a list event Event<List<dynamic>> into arguments, it's a workaround for the fact that Dart can't handle spread syntax. See [ListCallback] documentation.

[!] Removed:

• Redundant listener reference of itself, in EventListener callbacks: onAdd, onRemove, onCall and onCancel. For simplicity and to avoid dynamic listener's type issues. Use this if possible, or a reference of the listener instead.

Fixed:

• EventListener callbacks documentation
• Main example

Fixed:

• .emit() returns satisfaction

Added:

• EventListener property dataType

Fixed:

• Improved data type validation for dynamic data

Added:

• StreamEventListener, it's useful for having a streaming alternative to the default EventEmitter class

Fixed:

• Documentation with old property topic naming
• EventListener callbacks would throw an exception in some cases when using dynamic

Added:

• cancelAdded parameter to EventListener, tells the listener to automatically remove itself from the added EventEmitter when the .cancel() method is called. This is used in case you want to add your own canceling method. It essentially appends callbacks to the onCancel callbacks.

• .appendCallback() method to EventListener

[!] Changed:

• Typedef EventAddedCallback renamed to EventCallbackAdd
• Typedef EventRemoveCallback renamed to EventCallbackRemove
• Typedef EventCancelCallback renamed to EventCallbackCancel

Fixed:

• lint dependency moved to developer dependency

Changed:

• rxdart dependency updated from 0.27.3 to 0.27.5

Fixed:

• Type matching in .off()
• [!] Positional parameters in .off() changed to named parameters, as it was intended

Added:

• EventListener properties once and protected added
• EventListener callbacks onAdd, onRemove and onCancel
• EventListener handles custom events, they can also act like normal events. This is used to add context to an event if needed.
• EventEmitter .on() can catch the data as well as the Event<T> of the data

[!] Changed:

• EventStreamEmitter was renamed to StreamEventEmitter
• Event property topic renamed to type, to match JavaScript events
• Event property message renamed to data
• StreamEventEmitter's stream controller is now public

[!] Removed:

• EventEmitter sync
• EventListener property stream, subscription and messageType

Massive BREAKING CHANGES:

• EventEmitter was refactored to not depend on Streams, which means it now manages the callbacks itself. The emitter can have more complex listener logic. Before it would depend on StreamEventEmitter.

• File structure was changed to be more organized. This means you might need to update your imports.

• Sync is no longer a thing in the EventEmitter, it's a StreamEventEmitter only thing now.

• Other changes: [!]

Added:

• shield.io badges

Changed:

• ChangeLog's format

Changed:

• .onAny in EventEmitter now returns an EventListener

Fixed:

• In some cases, canceled listeners didn't get removed, now it's more accurate

Fixed:

• Make package only dart dependant

Added:

• .emitEvent() emits an existing event, without having to create a new one

Added:

• rxdart package dependency, for better-implemented streams

Fixed:

• Cast with dynamic type would break unexpectedly

Fixed:

• .onAny return type (Still has errors)

Changed:

• Filter .onAny<T>() by type

Fixed:

• pubspec.yaml clean up
• Example with final

Changed:

• Package description and documentation for type safety promotion

Added:

• More documentation (Why is this package different?)

Fixed:

• Documentation typos

Changed:

• once in EventEmitter now returns a Future with the message, allowing to await (still needs a callback)
• Separated EventEmitter and EventStreamEmitter classes into different files
• Internal variable names for simplification

Removed:

• send for simplification, the same could be achieved with emit

Removed:

• Package dependency flutter_lints

Fixed:

• StreamSubscription, cancel instances

Changed:

• on to return an EventListener, instead of a StreamSubscription

Fixed:

• Package description (was too long)

Initial release: EventEmitter