@react-nano/use-event-source

A lightweight EventSource (server-sent-events) hook for react, written in TypeScript

Usage no npm install needed!

<script type="module">
  import reactNanoUseEventSource from 'https://cdn.skypack.dev/@react-nano/use-event-source';
</script>

README

@react-nano/use-event-source

License Minified + gzipped size NPM version Stars Watchers

A lightweight EventSource (server-sent-events) hook for react, written in TypeScript.

Why Use @react-nano/use-event-source?

  • 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.

How to Use

Check out the documentation

Report Issues

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.

Contribute

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.

License

@react-nano 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.