Initial commit
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [iceshrimp-sdk](./iceshrimp-sdk.md) > [ChannelConnection](./iceshrimp-sdk.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-sdk.channelconnection._constructor_.md) | | Constructs a new instance of the <code>Connection</code> class |
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [channel](./iceshrimp-sdk.channelconnection.channel.md) | | string | |
|
||||
| [id](./iceshrimp-sdk.channelconnection.id.md) | <code>abstract</code> | string | |
|
||||
| [inCount](./iceshrimp-sdk.channelconnection.incount.md) | | number | |
|
||||
| [name?](./iceshrimp-sdk.channelconnection.name.md) | | string | _(Optional)_ |
|
||||
| [outCount](./iceshrimp-sdk.channelconnection.outcount.md) | | number | |
|
||||
| [stream](./iceshrimp-sdk.channelconnection.stream.md) | <code>protected</code> | [Stream](./iceshrimp-sdk.stream.md) | |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [dispose()](./iceshrimp-sdk.channelconnection.dispose.md) | <code>abstract</code> | |
|
||||
| [send(type, body)](./iceshrimp-sdk.channelconnection.send.md) | | |
|
||||
|
||||
Reference in New Issue
Block a user