mirror of
https://iceshrimp.dev/limepotato/jormungandr-bite.git
synced 2024-11-25 11:27:31 -07:00
91dddc439f
This resolves possible confusion between iceshrimp-js (this project) and iceshrimp-sdk (the package)
1.3 KiB
1.3 KiB
Home > iceshrimp-sdk > 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) |