ReactiveX / ReactiveX/rxjs

Documentation (in particular Observable.webSocket)

Open
#2,193 12 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs help wanted
Dominant language
TypeScript
Stars
31.7k
Forks
3k
PR merge metrics
No merged PRs in 30d

Description

Hi Guys,

First of all congrats on releasing the final version, I appreciate the work everyone has put into this project as I've been closely following. Now that the final version is released I was hoping to find some more complete API documentation. In this case I was looking to create an observable from web sockets.

I went to the API docs which tell me I need to pass urlConfigOrSource but I could not figure out how to set it up, am I missing something?
Moving on Observable.webSocket returns a WebSocketSubject so I tried to find out how to use it. All the API docs tell me is We need this JSDoc comment for affecting ESDoc.

Just to compare Observable.fromPromise has a neat little example that tells me how to use it.

I would really like to fully start using RxJS 5 when we build our next product but the lack of documentation prevents us from doing so. If we were to use it then I'm sure we would also contribute if we find bugs as we go along.

Am I missing an important piece here?
Are there any examples elsewhere?
How can I get involved to help improving the docs?

Again thanks for this great library.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Observable.webSocket API documentation and its description of urlConfigOrSource, then review the WebSocketSubject entry and compare them with the Observable.fromPromise example. The documentation should explain how to configure and use Observable.webSocket and WebSocketSubject with complete examples, while making the relevant API pages understandable to users.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.