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

37 lines
1.3 KiB
Markdown
Raw Normal View History

2023-07-20 04:17:05 +09:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [firefish-js](./firefish-js.md) &gt; [Stream](./firefish-js.stream.md)
## Stream class
**Signature:**
```typescript
export default class Stream extends EventEmitter<StreamEvents>
```
**Extends:** EventEmitter&lt;StreamEvents&gt;
## 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) | | |