Class Collector

Collect a single line from the server.

Hierarchy

Collector
- NickServCollector

Implements

IQueue<IIRCLine>

Index

Constructors

Properties

await from? match?

Methods

Constructors

constructor

new Collector(await: string, resolve: ((lines: IIRCLine) => void), from?: string, match?: ((line: IIRCLine) => boolean)): Collector
Parameters
- await: string
- resolve: ((lines: IIRCLine) => void)
  - - (lines: IIRCLine): void
    - Parameters
      
      lines: IIRCLine
      
      Returns void
- Optional from: string
- Optional match: ((line: IIRCLine) => boolean)
  - - (line: IIRCLine): boolean
    - Parameters
      
      line: IIRCLine
      
      Returns boolean
Returns Collector
- Defined in utility/collector.ts:7

Properties

await

await: string

Wait for this command from the server.

`Optional` from

from?: string

From nickname, used for NOTICE and PRIVMSG collectors.

`Optional` match

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

Type declaration

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

Methods

do

do(line: IIRCLine): void
Resolve the collector.
Parameters
- line: IIRCLine
  
  The line resolving to await
Returns void
Implementation of IQueue.do
- Defined in utility/collector.ts:14

Generated using TypeDoc