Interface IIRCWrapper

Hierarchy

IWritableEventEmitter
- IIRCWrapper

Implemented by

IRCConnection

Index

Properties

authenticated channels connected connector options queue serverData

Methods

connect disconnect emit getPing list names on setNick useCollector who whois write

Properties

authenticated

authenticated: boolean

Login success status.

channels

channels: string[]

Channels the bot is currently in.

connected

connected: boolean

Get connection status. authenticated is a more reliable indicator of a successful connection.

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

Methods

connect

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

Returns Promise<void>
- Defined in types/impl.interface.ts:68

disconnect

disconnect(reason?: string): Promise<void>
Disconnect from the IRC server gracefully, sends QUIT.
Parameters
- Optional reason: string
  
  Reason for disconnection
Returns Promise<void>
- Defined in types/impl.interface.ts:73

emit

emit(event: string, ...args: any[]): void
Parameters
- event: string
- Rest ...args: any[]
Returns void
Inherited from IWritableEventEmitter.emit
- Defined in types/impl.interface.ts:6

getPing

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

Returns
Ping in milliseconds

Returns Promise<number>
- Defined in types/impl.interface.ts:85

list

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

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

Returns Promise<string[][]>
- Defined in types/impl.interface.ts:108

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[]>
- Defined in types/impl.interface.ts:103

on

on(event: string, handler: ((...args: any[]) => void)): void
Parameters
- event: string
- handler: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Inherited from IWritableEventEmitter.on
- Defined in types/impl.interface.ts:7

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
- Defined in types/impl.interface.ts:80

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
- Defined in types/impl.interface.ts:117

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[]>
- Defined in types/impl.interface.ts:97

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>
- Defined in types/impl.interface.ts:91

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
Overrides IWritableEventEmitter.write
- Defined in types/impl.interface.ts:64

Generated using TypeDoc