Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing usage documentation #25

Open
monsterbitar opened this issue Feb 16, 2020 · 2 comments
Open

missing usage documentation #25

monsterbitar opened this issue Feb 16, 2020 · 2 comments

Comments

@monsterbitar
Copy link

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?

@mepc36
Copy link

mepc36 commented Dec 17, 2021

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.

@MatthewWid
Copy link

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants