Class IRCNickList

Manages a nicklist for your IRC connection, complete with modes and prefixes.

Hierarchy

TypedEventEmitter<NickListEvents>
- IRCNickList

Index

Constructors

Properties

Accessors

modes nickname prefixes supportedModes

Methods

addListener emit getChannelByName getNickFromChannel getPrefixFromModes handleJoin handleLeave handleMode handleNames handleNick handleWho handlers nickHasPrefix on once removeAllListeners removeEventListener removeNickIfExists stripPrefix

Constructors

constructor

new IRCNickList(irc: IIRCWrapper): IRCNickList
Parameters
- irc: IIRCWrapper
Returns IRCNickList
Overrides TypedEventEmitter.constructor
- Defined in utility/nicklist/nicklist.ts:14

Properties

channels

channels: INicklistChannel[] = []

irc

irc: IIRCWrapper

Accessors

modes

get modes(): string[]
Available user modes with prefixes

Returns string[]
- Defined in utility/nicklist/nicklist.ts:36

nickname

get nickname(): string
Get my nickname

Returns string
- Defined in utility/nicklist/nicklist.ts:22

prefixes

get prefixes(): string[]
Available user prefixes

Returns string[]
- Defined in utility/nicklist/nicklist.ts:29

supportedModes

get supportedModes(): Record<string, string>
List of supported prefix modes

Returns Record<string, string>
- Defined in utility/nicklist/nicklist.ts:43

Methods

addListener

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

emit

emit<E>(event: E, ...args: Parameters<NickListEvents[E]>): void
Type Parameters
- E extends keyof NickListEvents
Parameters
- event: E
- Rest ...args: Parameters<NickListEvents[E]>
Returns void
Inherited from TypedEventEmitter.emit
- Defined in utility/typed-event-emitter.ts:30

getChannelByName

getChannelByName(channel: string): undefined | INicklistChannel
Find a channel by name

Returns
Channel object or undefined
Parameters
- channel: string
  
  Channel name
Returns undefined | INicklistChannel
- Defined in utility/nicklist/nicklist.ts:73

getNickFromChannel

getNickFromChannel(channel: INicklistChannel, nickname: string): undefined | INicklistNick
Get nick object from channel, if exists.

Returns
Nick object
Parameters
- channel: INicklistChannel
  
  Channel object
- nickname: string
  
  Nickname
Returns undefined | INicklistNick
- Defined in utility/nicklist/nicklist.ts:295

getPrefixFromModes

getPrefixFromModes(modes: string[]): string
Get the applicable prefix for a list of user channel modes.

Returns
Prefix or empty string
Parameters
- modes: string[]
  
  List of modes
Returns string
- Defined in utility/nicklist/nicklist.ts:325

handleJoin

handleJoin(channel: string, nickname: string): void
Handle a user join event.
Parameters
- channel: string
  
  Channel
- nickname: string
  
  Nickname
Returns void
- Defined in utility/nicklist/nicklist.ts:82

handleLeave

handleLeave(nickname: string, channel?: string): void
Handles QUIT, PART and KICK events (user left channel).
Parameters
- nickname: string
  
  Nickname
- Optional channel: string
  
  Optional channel, if missing, removes from all
Returns void
- Defined in utility/nicklist/nicklist.ts:183

handleMode

handleMode(channel: string, mode: string, modeTarget: string, method: string): void
Handle channel modes.
Parameters
- channel: string
  
  Channel
- mode: string
  
  Mode
- modeTarget: string
  
  User
- method: string
  
  Add or remove (+ or -)
Returns void
- Defined in utility/nicklist/nicklist.ts:231

handleNames

handleNames(channel: string, names: string[]): void
Handle NAMES reply.
Parameters
- channel: string
  
  Channel
- names: string[]
  
  Nick list
Returns void
- Defined in utility/nicklist/nicklist.ts:109

handleNick

handleNick(oldNick: string, newNick: string): void
Handle nickname changes.
Parameters
- oldNick: string
  
  Old nickname
- newNick: string
  
  New nickname
Returns void
- Defined in utility/nicklist/nicklist.ts:272

handleWho

handleWho(whoList: WhoResponse[]): void
Handle a WHO response list, sets hidden modes for nicks
Parameters
- whoList: WhoResponse[]
  
  WHO reply
Returns void
- Defined in utility/nicklist/nicklist.ts:138

`Private` handlers

handlers(): void
Returns void
- Defined in utility/nicklist/nicklist.ts:349

nickHasPrefix

nickHasPrefix(nick: string): boolean
Does the provided nickname currently have a supported prefix.

Returns
boolean
Parameters
- nick: string
  
  Nickname with a prefix
Returns boolean
- Defined in utility/nicklist/nicklist.ts:52

on

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

once

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

removeAllListeners

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

removeEventListener

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

removeNickIfExists

removeNickIfExists(channel: INicklistChannel, nickname: string): boolean
Remove a nickname from channel, if exists.
Parameters
- channel: INicklistChannel
  
  Channel object
- nickname: string
  
  Nickname
Returns boolean
- Defined in utility/nicklist/nicklist.ts:304

stripPrefix

stripPrefix(nick: string): string
Strip prefix from nickname, if exists

Returns
Nickname without prefix
Parameters
- nick: string
  
  Nickname with a prefix
Returns string
- Defined in utility/nicklist/nicklist.ts:61

Generated using TypeDoc