Skip to main content

Module request

Module request 

Source
Expand description

The frames sent: subscribe, unsubscribe, ping, and a post, which carries an info read or a signed action over the socket instead of over HTTP. Each is one text frame, as JSON.stringify would write it, keys in the docs’ order.

Enums§

Post
What a post carries: an info read, as it would be posted to /info, or a signed action, the whole /exchange body. Either is kept as written, key order and digits, since an action’s signature is over exactly what was built.

Constants§

PING
The heartbeat. The venue answers {"channel":"pong"}.

Functions§

post
{"method":"post","id":..,"request":{"type":"info"|"action","payload":..}}. The answer comes on the channel post with the same id.
subscribe
{"method":"subscribe","subscription":{...}}.
unsubscribe
{"method":"unsubscribe","subscription":{...}}, with the same object the subscribe sent: the venue matches the options too.