iceshrimp/packages/iceshrimp-js/markdown/iceshrimp-js.stream.usechannel.md

Home > iceshrimp-js > Stream > useChannel

Stream.useChannel() method

Signature:

useChannel<C extends keyof Channels>(
		channel: C,
		params?: Channels[C]["params"],
		name?: string,
	): Connection<Channels[C]>;

Parameters

Parameter	Type	Description
channel	C
params	Channels[C]["params"]	(Optional)
name	string	(Optional)

Returns:

Connection<Channels[C]>