Class WhoCollector

Get a full WHO response from the server

352 - WHO line: <channel> <user> <host> <server> <nick> <H|G>[*][@|+] :<hopcount> <real_name>

315 - end of WHO

Hierarchy

MultiLineCollector
- WhoCollector

Index

Constructors

Properties

additional await buffer match?

Methods

Constructors

constructor

new WhoCollector(resolve: ((lines: IIRCLine[]) => void), target: string): WhoCollector
Parameters
- resolve: ((lines: IIRCLine[]) => void)
  - - (lines: IIRCLine[]): void
    - Parameters
      
      lines: IIRCLine[]
      
      Returns void
- target: string
Returns WhoCollector
Overrides MultiLineCollector.constructor
- Defined in utility/collector.ts:99

Properties

additional

additional: string[]

Append lines with these commands to buffer.

await

await: string

Wait for this command from the server.

buffer

buffer: IIRCLine[] = []

Buffer list of additional data.

`Optional` match

match?: ((line: IIRCLine) => boolean)

Type declaration

- (line: IIRCLine): boolean
- Parameters
  - line: IIRCLine
  Returns boolean

Methods

digest

digest(line: IIRCLine): void
Line matching commands in additional will call this function. Use it to populate the buffer.
Parameters
- line: IIRCLine
  
  Server line
Returns void
Inherited from MultiLineCollector.digest
- Defined in utility/collector.ts:36

do

do(line: IIRCLine, data: IIRCLine[]): void
Resolve the collector.
Parameters
- line: IIRCLine
  
  The line resolving to await
- data: IIRCLine[]
  
  Additional data in buffer, usually only present when using additional
Returns void
Inherited from MultiLineCollector.do
- Defined in utility/collector.ts:32

Generated using TypeDoc