Skip to content

Missing documentation for global publish() and peers() #170

@hrjAtLC

Description

@hrjAtLC

I was able to discover the publish() and peers() methods by looking at the PRs. But for other new users it would be beneficial to mention or document them.

Aside, what is the timing contract for publish(). It doesn't return a Promise, so does publish() return only after the message has been sent on the socket? Or does it enqueue it and return immediately. I assume that this depends on the underlying WS implementation, but it would be great if the contract could be standardized, or documented

URLs

https://crossws.h3.dev/guide/pubsub

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions