Skip to content
tickcli

RemoteOptions

Properties

Section titled “Properties”

address?

Section titled “address?”

optional address?: (req) => string

the client address after your trusted-proxy rule (default: the socket’s address)

Parameters

Section titled “Parameters”
req
Section titled “req”

IncomingMessage

Returns

Section titled “Returns”

string

deployment

Section titled “deployment”

deployment: (id) => Deployment | Promise<Deployment | null | undefined> | null | undefined

look a deployment up by id (your table, a JSON file); null or undefined = no such deployment

Parameters

Section titled “Parameters”
id
Section titled “id”

string

Returns

Section titled “Returns”

Deployment | Promise<Deployment | null | undefined> | null | undefined

heartbeat?

Section titled “heartbeat?”

optional heartbeat?: Heartbeat

hub

Section titled “hub”

hub: RoomHub

path?

Section titled “path?”

optional path?: string

socket path (default “/room”)