37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md)
|
||
|
|
|
||
|
|
## Stream class
|
||
|
|
|
||
|
|
**Signature:**
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
export default class Stream extends EventEmitter<StreamEvents>
|
||
|
|
```
|
||
|
|
**Extends:** EventEmitter<StreamEvents>
|
||
|
|
|
||
|
|
## Constructors
|
||
|
|
|
||
|
|
| Constructor | Modifiers | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| [(constructor)(origin, user, options)](./firefish-js.stream._constructor_.md) | | Constructs a new instance of the <code>Stream</code> class |
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
| Property | Modifiers | Type | Description |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| [state](./firefish-js.stream.state.md) | | "initializing" \| "reconnecting" \| "connected" | |
|
||
|
|
|
||
|
|
## Methods
|
||
|
|
|
||
|
|
| Method | Modifiers | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| [close()](./firefish-js.stream.close.md) | | |
|
||
|
|
| [disconnectToChannel(connection)](./firefish-js.stream.disconnecttochannel.md) | | |
|
||
|
|
| [removeSharedConnection(connection)](./firefish-js.stream.removesharedconnection.md) | | |
|
||
|
|
| [removeSharedConnectionPool(pool)](./firefish-js.stream.removesharedconnectionpool.md) | | |
|
||
|
|
| [send(typeOrPayload, payload)](./firefish-js.stream.send.md) | | |
|
||
|
|
| [useChannel(channel, params, name)](./firefish-js.stream.usechannel.md) | | |
|
||
|
|
|