Phoenix: Documentation has problems about way to start Long-polling by Phoenix Channels JavaScript client

[toyoaki-k]

Hello!

Problem

I tried to use long polling by js client, and read the documentation.
I found 2 problems about docs.

1. In doc about Socket object, It says that if user want to use long polling user should give opts.transport as Socket constructor parameter, and type of transport is string. But it seems wrong to me because in fact Socket constructor expects a object which is either WebSocket or LongPoll as below.
   this.transport = opts.transport || global.WebSocket || LongPoll

2. So in fact user needs to import LongPoll object and give it to Socket initialization as its constructor parameter, but there are no docs about LongPoll object. So user can not know way to use LongPoll object.

Expected

1. type of opts.transport is Object(Websocket or LongPoll)
2. docs about LongPoll object

thank you for reading!

[snewcomer]

@toyoaki-k A few notes and improvements for LongPoll would be welcome!

It is in fact an Object type. Good point. Also I think some docs for the LongPoll class would be welcome fo those that need to support certain protocols. A few lines how to enable Long Poll with how to setup the Socket with it would be super useful!

Let me know if you have other questions 👍

[toyoaki-k]

@snewcomer
Thank you for your reply.
Got it! Let me contribute!

[chrismccord]

@toyoaki-k Can you send a PR? Thanks!

[J0]

Hey @toyoaki-k,

Just wanted to check if you're still working on this issue and/or if it has already been fixed. Would love to help finish up this issue if no one else is working on it. Let me know!

Joel

[toyoaki-k]

Hi @J0,
So sorry for my slow work!
I sent a PR. Could you review it?

[J0]

Hey @toyoaki-k,

Sorry for the delay. Happy to review but do keep in mind I'm not a member of Phoenix so whatever Jose or Chris says goes. I'm happy to offer general feedback though!

[toyoaki-k]

@J0
Oh, sorry I misunderstood. I got it!
If you give me general feedback, it is very helpful for me. Thanks!

[josevalim]

Closing in favor of the PR!