Skip to content

JS options when connecting the socket should be documented, and general JS documentation improvements #3361

@srcrip

Description

@srcrip

Hey everyone,

I noticed that I can not seem to find official documentation for the options to socket connection in JavaScript. I think we really need to document this in ex doc. Maybe it's there and I just missed it?

Also I am interested in taking a crack at the JS documentation overall. I think there should be a new page in the docs that covers:

  • the options to the live socket
  • the exact functions available on the socket/hooks (I know this is covered in the section on js interop but I think it deserves its own section)
  • some short blurb about the types, jsdoc vs TS types, and how you can add TS to a new phoenix project

I want to try writing this page but I'm not exactly sure of what some of those options on the live socket actually do. Also has anyone else thought about good ways to document JS functions in ex doc?

Addendum that I'm also curious about:

  • the jsdoc types should have documentation in them, so it shows up in ides
  • wasn't there some talk a while ago about moving the types into this repo itself? Did that ever happen? I'm on my phone right now so I can't easily find it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions