A lightweight EventSource (server-sent-events) hook for react, written in TypeScript.
Why use this hook?
- Very lightweight (see the badges above for the latest size).
- Flexible and dead simple to use.
- Written in TypeScript
- Only has one required peer dependency: React 16.8.0 or higher.
- Liberal license: zlib/libpng
Beware: This is currently work in progress. The API might change.
Installation via NPM
npm i react-use-event-source-ts
This library is shipped as es2015 modules. To use them in browsers, you'll have to transpile them using webpack or similar, which you probably already do.
;;;// Create a custom hook to simplify the process:
// Create an EventSourceEventSource | null, // the generated EventSource.. on first call, it will be null.EventSourceStatus // The status of the connection can be used to display a busy indicator, error indicator, etc.];;// Add a listener to the EventSource;
Something not working quite as expected? Do you need a feature that has not been implemented yet? Check the issue tracker and add a new one if your problem is not already listed. Please try to provide a detailed description of your problem, including the steps to reproduce it.
Awesome! If you would like to contribute with a new feature or submit a bugfix, fork this repo and send a pull request. Please, make sure all the unit tests are passing before submitting and add new ones in case you introduced new features.
react-use-event-source-ts has been released under the zlib/libpng license, meaning you can use it free of charge, without strings attached in commercial and non-commercial projects. Credits are appreciated but not mandatory.