<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [iceshrimp-js](./iceshrimp-js.md) &gt; [Stream](./iceshrimp-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)](./iceshrimp-js.stream._constructor_.md) |  | Constructs a new instance of the <code>Stream</code> class |

## Properties

|  Property | Modifiers | Type | Description |
|  --- | --- | --- | --- |
|  [state](./iceshrimp-js.stream.state.md) |  | "initializing" \| "reconnecting" \| "connected" |  |

## Methods

|  Method | Modifiers | Description |
|  --- | --- | --- |
|  [close()](./iceshrimp-js.stream.close.md) |  |  |
|  [disconnectToChannel(connection)](./iceshrimp-js.stream.disconnecttochannel.md) |  |  |
|  [removeSharedConnection(connection)](./iceshrimp-js.stream.removesharedconnection.md) |  |  |
|  [removeSharedConnectionPool(pool)](./iceshrimp-js.stream.removesharedconnectionpool.md) |  |  |
|  [send(typeOrPayload, payload)](./iceshrimp-js.stream.send.md) |  |  |
|  [useChannel(channel, params, name)](./iceshrimp-js.stream.usechannel.md) |  |  |

