2.0.7 • Published 4 years ago
react-birch-event-emitter v2.0.7
react-birch-event-emitter - A Simple Event Library
Features include:
- Unlike
on,off,addListener,removeListeneretc.EventEmitterevent subscriptions return aDisposableobject withdispose()method to unsubscribe from event. - Above feature allows you to group event subscriptions using
DisposablesCompositeand dispose them all with one call, i.eDisposableComposite#dispose() Listeners voice matters!! You can now dispatch an event using
EventEmitter#dispatchWithReturnwhere each listener's return value can be accessed from returned array.The Last feature can come in handy like in example below:
// Here some listeners are subscribed to `onWillCommit` event, but we can allow listeners to disagree if they deem so
commitChange(change) {
// ...
// here we'll notify all `will-commit` listeners, but if one of them returns false, we'll abort the `commit` operation
if (this.eventEmitter.dispatchWithReturn('will-commit', this.currentValue).some((canCommit) => canCommit === false)) {
return
}
// Proceed with commit opertaion
// ...
}Usage
npm i eventEmitter// Textbuffer.ts (I highly recommend TypeScript as you can get a huge performance boost by using `enum`s instead of strings as event identifiers)
import { EventEmitter } from 'eventEmitter'
// ...
enum TextBufferEvent {
WillSave,
WillPaste,
}
class TextBuffer implements IDisposable {
private eventEmitter = new EventEmitter<TextBufferEvent>()
// ...
public onWillPaste(callback: (textFragment: TextFragment, pos: Position) => void): IDiposable {
return this.eventEmitter.on(TextBufferEvent.Will, callback)
}
public onWillSave(callback: () => void): IDiposable {
return this.eventEmitter.on(TextBufferEvent.WillSave, callback)
}
// ...
private _pasteTextFragment(textFragment: TextFragment, pos: Position): boolean {
// ...
this.eventEmitter.dispatch(TextBufferEvent.WillPaste, textFragment, pos) // dispatch with args
// ...
}
private _trySave(): boolean {
// ...
this.eventEmitter.dispatch(TextBufferEvent.WillSave) // dispatch without args
// ...
}
}Full API can be found in index.d.ts
License
MIT