express-sse icon indicating copy to clipboard operation
express-sse copied to clipboard

missing usage documentation

Open monsterbitar opened this issue 5 years ago • 2 comments

There is an example in the README but generally there is a clear lack of documentation.

I would encourage someone to add basic documentation on each of the functionalities supported by this library: what does the functions do, what are the parameters and structures and what's the expected usage?

monsterbitar avatar Feb 16 '20 15:02 monsterbitar

I second this request, but we can also be the change we wish to see in the world (:prayer-hands-emoji:)

Could anyone who sees this drop an example? It's my first time working with SSE and I don't know enough about the pattern to be able to derive it from the documentation. I was able to get the example working from a S.O.F. post here that uses pure express to implement SSE, but that's about it.

mepc36 avatar Dec 17 '21 11:12 mepc36

@mepc36 If you're still looking for an SSE solution I have been working on a library that has been gaining some traction recently. 🙂

It has comprehensive usage documentation with guides and examples, TypeScript typings (#33), support for channels (#42) and works with all of the most popular web-server frameworks and latest Node versions (#37).

Check it out here: https://github.com/MatthewWid/better-sse. I specifically designed it to be a vast improvement over the existing Node SSE libraries. Please let me know if it helps at all!

MatthewWid avatar Jan 08 '22 11:01 MatthewWid