Manual Reference Source Test

Typedef

Static Public Summary
public	BotOptions: Object The options to be passed into Bot constructor.
public	DataType: string \| Uint8Array Is a helper type representing types that can be sent/received over a web group.
public	WebGroupOptions: Object The options to be passed into WebGroup constructor.

Static Public

public BotOptions: Object source

The options to be passed into Bot constructor.

Properties:

Name	Type	Attribute	Description
topology	Topology	optional	See WebGroupOptions.topology
signalingServer	string	optional	See WebGroupOptions.signalingServer
rtcConfiguration	RTCConfiguration	optional	See WebGroupOptions.rtcConfiguration
autoRejoin	boolean	optional	See WebGroupOptions.autoRejoin
bot	Object		Server related options of the bot.
bot.server	HttpServer \| HttpsServer		NodeJS http(s) server.
bot.url	string	optional	Bot server URL.
bot.perMessageDeflate	boolean	optional	Enable/disable permessage-deflate.
bot.leaveOnceAlone	boolean	optional	If true, bot will live (disconnect from the signaling server) if no other peers left in the group.

public DataType: string | Uint8Array source

Is a helper type representing types that can be sent/received over a web group.

public WebGroupOptions: Object source

The options to be passed into WebGroup constructor.

Properties:

Name	Type	Attribute	Description
topology	Topology	optional	Topology identifier (Full mesh is the only one supported by Netflux for now).
signalingServer	string	optional	Signaling URL for WebRTC.
rtcConfiguration	RTCConfiguration	optional	Configuration for WebRTC.
autoRejoin	boolean	optional	Whether to automatically rejoin the web group on disconnect or not. Its value may be modified after WebGroup instantiation at any time.