mirror of
https://iceshrimp.dev/limepotato/jormungandr-bite.git
synced 2024-11-28 12:57:31 -07:00
91dddc439f
This resolves possible confusion between iceshrimp-js (this project) and iceshrimp-sdk (the package)
24 lines
807 B
Markdown
24 lines
807 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [iceshrimp-sdk](./iceshrimp-sdk.md) > [Stream](./iceshrimp-sdk.stream.md) > [useChannel](./iceshrimp-sdk.stream.usechannel.md)
|
|
|
|
## Stream.useChannel() method
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
useChannel<C extends keyof Channels>(channel: C, params?: Channels[C]["params"], name?: string): Connection<Channels[C]>;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| channel | C | |
|
|
| params | [Channels](./iceshrimp-sdk.channels.md)<!-- -->\[C\]\["params"\] | _(Optional)_ |
|
|
| name | string | _(Optional)_ |
|
|
|
|
**Returns:**
|
|
|
|
[Connection](./iceshrimp-sdk.channelconnection.md)<!-- --><[Channels](./iceshrimp-sdk.channels.md)<!-- -->\[C\]>
|
|
|