Interface IIRCOptions

Hierarchy

  • IIRCOptions

Properties

bot? channels? connOpts? host hostname? nick nickserv? password? port? realname? sasl? ssl? username?

Properties

Optional bot

bot?: boolean

Set +B mode on self (servers may not all support this!)

Optional channels

channels?: string[]

List of channels to join on connect

Optional connOpts

connOpts?: Record<string, unknown>

Additional options for connections, usually passed right along to socket without additional alterations.

Special cases for included connections:

  • path - IRCWebSocketConnector will append this to the WebSocket URL.
  • skipPings - Included connectors will not respond to PINGs if set.
  • wsPingInterval - IRCWebSocketConnector pings the server instead of the server pinging it. Here, you can set the ping interval in milliseconds. Defaults to 60000, 1 minute. This setting is ignored if you have specified skipPings, in which case, you will need to use a custom pinger for the WebSocket.

host

host: string

IRC server hostname

Optional hostname

hostname?: string

Your user's hostname, this will be set automatically on connect. Setting it manually has no effect.

nick

nick: string

IRC nickname

Optional nickserv

nickserv?: INickServOptions

Additional NickServ options

Optional password

password?: string

IRC server password. Sometimes also used as nickserv password.

Optional port

port?: number

IRC server port

Optional realname

realname?: string

IRC realname

Optional sasl

sasl?: boolean

Enable SASL authentication.

Optional ssl

ssl?: boolean

Enable SSL

Optional username

username?: string

IRC username

Settings

Member Visibility

Theme

Generated using TypeDoc