iceshrimp/packages/firefish-js/markdown/firefish-js.channelconnection.md

Home > firefish-js > ChannelConnection

ChannelConnection class

Signature:

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)		Constructs a new instance of the Connection class

Properties

Property	Modifiers	Type	Description
channel		string
id	abstract	string
inCount		number
name?		string	(Optional)
outCount		number
stream	protected	Stream

Methods

Method	Modifiers	Description
dispose()	abstract
send(type, body)