mirror of
https://iceshrimp.dev/limepotato/jormungandr-bite.git
synced 2024-11-26 11:57:34 -07:00
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [iceshrimp-js](./iceshrimp-js.md) > [ChannelConnection](./iceshrimp-js.channelconnection.md)
|
||
|
|
|
||
|
|
## ChannelConnection class
|
||
|
|
|
||
|
|
**Signature:**
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
export declare abstract class Connection<
|
||
|
|
Channel extends AnyOf<Channels> = any,
|
||
|
|
> extends EventEmitter<Channel["events"]>
|
||
|
|
```
|
||
|
|
**Extends:** EventEmitter<Channel\["events"\]>
|
||
|
|
|
||
|
|
## Constructors
|
||
|
|
|
||
|
|
| Constructor | Modifiers | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| [(constructor)(stream, channel, name)](./iceshrimp-js.channelconnection._constructor_.md) | | Constructs a new instance of the <code>Connection</code> class |
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
| Property | Modifiers | Type | Description |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| [channel](./iceshrimp-js.channelconnection.channel.md) | | string | |
|
||
|
|
| [id](./iceshrimp-js.channelconnection.id.md) | <code>abstract</code> | string | |
|
||
|
|
| [inCount](./iceshrimp-js.channelconnection.incount.md) | | number | |
|
||
|
|
| [name?](./iceshrimp-js.channelconnection.name.md) | | string | _(Optional)_ |
|
||
|
|
| [outCount](./iceshrimp-js.channelconnection.outcount.md) | | number | |
|
||
|
|
| [stream](./iceshrimp-js.channelconnection.stream.md) | <code>protected</code> | [Stream](./iceshrimp-js.stream.md) | |
|
||
|
|
|
||
|
|
## Methods
|
||
|
|
|
||
|
|
| Method | Modifiers | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| [dispose()](./iceshrimp-js.channelconnection.dispose.md) | <code>abstract</code> | |
|
||
|
|
| [send(type, body)](./iceshrimp-js.channelconnection.send.md) | | |
|
||
|
|
|