Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
better-sse
Advanced tools
better-sse - npm Package Versions
Changelog
0.7.0 - 2022-01-08
Added
- Added the ability to the
Session#pushmethod to set a custom event ID. - Added a new Session
pushevent that is emitted with the event data, name and ID when theSession#pushmethod is called. - Added the
Channel#stateproperty to have a safe namespace for keeping information attached to the channel.
Changed
- Update the arguments for the
Session#pushandChannel#broadcastmethods and their corresponding emitted event callbacks to always have the event data first and event name as an optional argument second. - Update the
Channel#broadcastmethod options TypeScript typings to explicitly mandate abooleanreturn-type instead of allowing any truthy or falsy value. - Update the
Channel#broadcastmethod event name argument to be optional and default to"message"if not given. - Update the
Session#stategeneric argument to default to a newSessionStateinterface that can be augmented via declaration merging to override the session state type for all session objects without explicitly providing a generic argument to each reference toSession. - Rename the Session and Channel
Eventsinterfaces toSessionEventsandChannelEventsrespectively and export them publicly allowing the user to properly type non-inlined event handler callback functions.
Changelog
0.6.0 - 2021-10-28
Added
- Added the
Session#iteratemethod that allows processing iterables and sending yielded values to the client as events. - Added types for
SessionandChannelevent listener callback function arguments. - Added the ability to type
Session#stateusing an optional generic argument forcreateSessionand theSessionconstructor.
Changed
- Rename the
Session#streameventoption toeventName.
Changelog
0.5.0 - 2021-07-17
Added
- Added broadcast channels that allow pushing events to multiple sessions at once.
- Added support for EventSource polyfills
event-source-polyfillandeventsource-polyfill. - Added the
Session#stateproperty to have a safe namespace for keeping information attached to the session.
Fixed
- Fixed TypeScript types for the
Session#lastIdnot being read-only.
Changelog
0.4.0 - 2021-07-09
Added
- Added an automated keep-alive mechanism that can be enabled or disable in the Session constructor options.
- Added the
Session#isConnectedboolean property.
Fixed
- Fixed an issue where installing the package using
npmwould throw an error mandating it be installed withpnpm.