SocketOptions
Properties
Section titled “Properties”address
Section titled “address”address:
string
client address, for the per-address caps (after your trusted-proxy rule)
authenticate?
Section titled “authenticate?”
optionalauthenticate?: (ticket) =>Identity|Promise<Identity|null> |null
otherwise: the first message must be {v:1, t:“auth”, ticket}; this turns the ticket into an identity, or null to refuse (4001)
Parameters
Section titled “Parameters”ticket
Section titled “ticket”unknown
Returns
Section titled “Returns”Identity | Promise<Identity | null> | null
heartbeat?
Section titled “heartbeat?”
optionalheartbeat?:Heartbeat
hub:
RoomHub
identity?
Section titled “identity?”
optionalidentity?:Identity
known at the upgrade (a pass cookie checked by the caller)