jormungandr-bite/packages/calckey-js/markdown/calckey-js.stream.md

Home > calckey-js > Stream

Stream class

Signature:

export default class Stream extends EventEmitter<StreamEvents> 

Extends: EventEmitter<StreamEvents>

Constructors

Constructor	Modifiers	Description
(constructor)(origin, user, options)		Constructs a new instance of the Stream class

Properties

Property	Modifiers	Type	Description
state		"initializing" | "reconnecting" | "connected"

Methods

Method	Modifiers	Description
close()
disconnectToChannel(connection)
removeSharedConnection(connection)
removeSharedConnectionPool(pool)
send(typeOrPayload, payload)
useChannel(channel, params, name)