signalr-event-emitter
v1.0.5
Published
A nicer way to receive SignalR events
Downloads
1
Maintainers
Readme
signalr-event-emitter
A utility function that allows for receiving method invocations from a SignalR hub in a type-safe way
Why?
Because the SignalR client library leaves a lot to be desired in terms of nice typescript support. The createSignalrEventEmitter
function in this package allows for defining event names and parameters via TypeScript.
Example
// build hub connection
const hubConnection = new signalR.HubConnectionBuilder()
.withUrl('/somehub')
.build();
// define method names and the parameters expected
interface Methods {
started: () => void;
progress: (processedCount: number, totalCount: number) => void;
finished: () => void;
}
// attach emitter
const emitter = createSignalrEventEmitter<Methods>(hubConnection);
emitter.on('progress', (processedCount, totalCount) => {
});