UNPKG

@react-nano/use-event-source

Version:

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

lusito.github.io/react-nano/

Lusito/react-nano

37 lines (23 loc) • 2.21 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# @react-nano/use-event-source [![License](https://flat.badgen.net/github/license/lusito/react-nano?icon=github)](https://github.com/Lusito/react-nano/blob/master/LICENSE) [![Minified + gzipped size](https://flat.badgen.net/bundlephobia/minzip/@react-nano/use-event-source?icon=dockbit)](https://bundlephobia.com/result?p=@react-nano/use-event-source) [![NPM version](https://flat.badgen.net/npm/v/@react-nano/use-event-source?icon=npm)](https://www.npmjs.com/package/@react-nano/use-event-source) [![Stars](https://flat.badgen.net/github/stars/lusito/react-nano?icon=github)](https://github.com/lusito/react-nano) [![Watchers](https://flat.badgen.net/github/watchers/lusito/react-nano?icon=github)](https://github.com/lusito/react-nano) 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 17.0.0 or higher. - Liberal license: [zlib/libpng](https://github.com/Lusito/react-nano/blob/master/LICENSE) **Beware**: This is currently work in progress. The API might change. ## How to Use Check out the [documentation](https://lusito.github.io/react-nano/use-event-source/setup.html) ## Report Issues Something not working quite as expected? Do you need a feature that has not been implemented yet? Check the [issue tracker](https://github.com/Lusito/react-nano/issues) 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](https://github.com/Lusito/react-nano/blob/master/LICENSE) license, meaning you can use it free of charge, without strings attached in commercial and non-commercial projects. Credits are appreciated but not mandatory.