Where is the doc for socket.js?

Phoenix Forum Questions / Help
, , ,
1

I can’t seem to locate the Doc for socket.js, I’d like to familiarize myself with all the APIs in that library. Does anyone have the link(s)? Thanks.

2

You can find the docs for phoenix.js here: https://hexdocs.pm/phoenix/js/

1 Like
3

Thanks.
By the way, the look-and-feel is different from the regular Phoenix Doc. Is it a work in progress?

4

This is because it’s not made with ex_doc (I suppose because it’s JS docs and not Elixir).

5

It makes it look like an orphaned project rather than an integral aspect of the Phoenix project. Thanks anyway.

6

Are you not able to find what you need in there? I am not sure what the problem is.

7

Easy man, just sharing an opinion. It doesn’t look like a doc from Phoenix. I saw the page first but wasn’t sure if it’s from the authentic source or a personal blog despite the fact that the page address seem right. That’s why i asked in the forum to be sure. Consistency in appearance matters.

8

ex_doc as mentioned can build elixir docs, but not js docs.

Also hexdocs is not really bound to ex_doc as well. There are also lot’s of erlang libraries on hex, which use edoc for documentation (https://hexdocs.pm/telemetry/); some libraries even build custom docs (https://hexdocs.pm/distillery/).

I can see that a different look an feel can be foreign though, especially if one looks at 99.5% ex_doc documentation.

1 Like
9

Thanks for your informative response.