iceshrimp/packages/iceshrimp-js/markdown/iceshrimp-js.stream.md

1.3 KiB

Home > iceshrimp-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)