WebPubSubClientProtocol interface

The interface to be implemented for a web pubsub subprotocol

Properties

isReliableSubProtocol	True if the protocol supports reliable features
name	The name of subprotocol. Name will be used in websocket subprotocol

parseMessages(string \| ArrayBuffer \| Buffer)	Creates WebPubSubMessage objects from the specified serialized representation.
writeMessage(WebPubSubMessage)	Write WebPubSubMessage to string or ArrayBuffer

True if the protocol supports reliable features

isReliableSubProtocol: boolean

boolean

The name of subprotocol. Name will be used in websocket subprotocol

name: string

string

Creates WebPubSubMessage objects from the specified serialized representation.

function parseMessages(input: string | ArrayBuffer | Buffer): null | WebPubSubMessage | WebPubSubMessage[]

The serialized representation

Write WebPubSubMessage to string or ArrayBuffer

function writeMessage(message: WebPubSubMessage): string | ArrayBuffer

The message to be written

string | ArrayBuffer