Class IRCConnection

Hierarchy

TypedEventEmitter<IRCConnectionEvents>
- IRCConnection

Implements

IIRCWrapper

Index

Constructors

Properties

_lastLineWasSupports _supportsDone authenticated channels connection? connector options queue serverData

Accessors

Constructors

constructor

new IRCConnection(options: IIRCOptions, connector: IIRCConnectorConstructor): IRCConnection
Parameters
- options: IIRCOptions
- connector: IIRCConnectorConstructor
Returns IRCConnection
Overrides TypedEventEmitter.constructor
- Defined in irc.ts:44

Properties

`Private` _lastLineWasSupports

_lastLineWasSupports: boolean = false

`Private` _supportsDone

_supportsDone: boolean = false

authenticated

authenticated: boolean = false

Login success status.

channels

channels: string[] = []

Channels the bot is currently in.

`Private` `Optional` connection

connection?: IIRCConnector

connector

connector: IIRCConnectorConstructor

The connector to use for connecting to the IRC server.

options

options: IIRCOptions

Connection options for the IRC server.

queue

queue: IQueue<any>[] = []

Current collectors waiting for their reply.

serverData

serverData: IIRCServerData = ...

Information about the IRC server gathered during runtime

Accessors

connected

get connected(): boolean
Get connection status. authenticated is a more reliable indicator of a successful connection.

Returns boolean
Implementation of IIRCWrapper.connected
- Defined in irc.ts:532

Methods

addListener

addListener<E>(event: E, fn: IRCConnectionEvents[E], once?: boolean): void
Type Parameters
- E extends keyof IRCConnectionEvents
Parameters
- event: E
- fn: IRCConnectionEvents[E]
- once: boolean = false
Returns void
Inherited from TypedEventEmitter.addListener
- Defined in utility/typed-event-emitter.ts:10

`Private` authenticate

authenticate(): void
Returns void
- Defined in irc.ts:67

connect

connect(): Promise<void>
Create a new connection to the configured IRC server.

Returns Promise<void>
Implementation of IIRCWrapper.connect
- Defined in irc.ts:473

disconnect

disconnect(reason?: string): Promise<void>
Disconnect from the IRC server gracefully, sends QUIT.
Parameters
- Optional reason: string
  
  Reason for disconnection
Returns Promise<void>
Implementation of IIRCWrapper.disconnect
- Defined in irc.ts:511

emit

emit<E>(event: E, ...args: Parameters<IRCConnectionEvents[E]>): void
Type Parameters
- E extends keyof IRCConnectionEvents
Parameters
- event: E
- Rest ...args: Parameters<IRCConnectionEvents[E]>
Returns void
Implementation of IIRCWrapper.emit

Inherited from TypedEventEmitter.emit
- Defined in utility/typed-event-emitter.ts:30

getPing

getPing(): Promise<number>
Asynchronously ping the server.

Returns
Ping in milliseconds

Returns Promise<number>
Implementation of IIRCWrapper.getPing
- Defined in irc.ts:545

`Private` handleServerLine

handleServerLine(line: IIRCLine): void
Parameters
- line: IIRCLine
Returns void
- Defined in irc.ts:139

`Private` handlers

handlers(): void
Returns void
- Defined in irc.ts:59

`Private` joinMissingChannels

joinMissingChannels(arr: string[]): void
Parameters
- arr: string[]
Returns void
- Defined in irc.ts:84

list

list(): Promise<string[][]>
Get a list of channels asynchronously

Returns
Channel list in [<channel>, <# visible>, <topic>][] format

Returns Promise<string[][]>
Implementation of IIRCWrapper.list
- Defined in irc.ts:597

names

names(channel: string): Promise<string[]>
Get a list of names in a channel asynchronously

Returns
String list of nicks (with mode prefixes preserved)
Parameters
- channel: string
  
  Channel to query
Returns Promise<string[]>
Implementation of IIRCWrapper.names
- Defined in irc.ts:579

on

on<E>(event: E, fn: IRCConnectionEvents[E]): void
Type Parameters
- E extends keyof IRCConnectionEvents
Parameters
- event: E
- fn: IRCConnectionEvents[E]
Returns void
Implementation of IIRCWrapper.on

Inherited from TypedEventEmitter.on
- Defined in utility/typed-event-emitter.ts:22

once

once<E>(event: E, fn: IRCConnectionEvents[E]): void
Type Parameters
- E extends keyof IRCConnectionEvents
Parameters
- event: E
- fn: IRCConnectionEvents[E]
Returns void
Inherited from TypedEventEmitter.once
- Defined in utility/typed-event-emitter.ts:26

`Private` pumpQueue

pumpQueue(line: IIRCLine): boolean
Parameters
- line: IIRCLine
Returns boolean
- Defined in irc.ts:99

removeAllListeners

removeAllListeners<E>(event: E): void
Type Parameters
- E extends keyof IRCConnectionEvents
Parameters
- event: E
Returns void
Inherited from TypedEventEmitter.removeAllListeners
- Defined in utility/typed-event-emitter.ts:58

removeEventListener

removeEventListener<E>(event: E, fn: IRCConnectionEvents[E]): void
Type Parameters
- E extends keyof IRCConnectionEvents
Parameters
- event: E
- fn: IRCConnectionEvents[E]
Returns void
Inherited from TypedEventEmitter.removeEventListener
- Defined in utility/typed-event-emitter.ts:45

setNick

setNick(newNick: string): void
Set a new nickname. A nick event will be fired for self. When setting the new nick fails, the connection will reset it and emit your previous nickname back in the nick event.
Parameters
- newNick: string
  
  New nickname
Returns void
Implementation of IIRCWrapper.setNick
- Defined in irc.ts:536

useCollector

useCollector(collector: IQueue<any>, line: string, ...args: any[]): void
Add a collector to the queue. This is used to grab lines from the server, wait for them and return them in a callback.
Parameters
- collector: IQueue<any>
  
  IRC line collector
- line: string
  
  Command to send to the server
- Rest ...args: any[]
  
  Arguments to the command
Returns void
Implementation of IIRCWrapper.useCollector
- Defined in irc.ts:616

who

who(target: string): Promise<WhoResponse[]>
Asynchronous WHO query on target

Returns
Parsed WHO response object array
Parameters
- target: string
  
  Channel or nick to query
Returns Promise<WhoResponse[]>
Implementation of IIRCWrapper.who
- Defined in irc.ts:569

whois

whois(nick: string): Promise<WhoisResponse>
Asynchronous WHOIS query on nick

Returns
Parsed WHOIS response object
Parameters
- nick: string
  
  Nick to query
Returns Promise<WhoisResponse>
Implementation of IIRCWrapper.whois
- Defined in irc.ts:559

write

write(format: string, ...args: any[]): void
Send a raw command to the server.

WARNING: Line break characters could have an unintended side-effect! Filter user-generated content!
Parameters
- format: string
  
  Command
- Rest ...args: any[]
  
  Command arguments
Returns void
Implementation of IIRCWrapper.write
- Defined in irc.ts:55

Generated using TypeDoc