Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WST

Hierarchy

  • EventEmitter
    • WST

Index

Constructors

constructor

  • new WST(socket: WS): WST
  • Parameters

    • socket: WS

    Returns WST

Properties

UUID

UUID: string = v4()

options

options: _Telnet.TelnetOptionMatrix = new _Telnet.TelnetOptionMatrix()

Private responder

responder: Nullable<(data: string) => void> = null

Private socket

socket: WS

Static Telnet

Telnet: Telnet = _Telnet

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Private HandleData

  • HandleData(data: Buffer): void

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

close

  • close(code?: undefined | number, reason?: undefined | string): void
  • Parameters

    • Optional code: undefined | number
    • Optional reason: undefined | string

    Returns void

do

  • do(option: _Telnet.TelnetOption): void
  • Parameters

    • option: _Telnet.TelnetOption

    Returns void

dont

  • dont(option: _Telnet.TelnetOption): void
  • Parameters

    • option: _Telnet.TelnetOption

    Returns void

emit

  • emit(event: "error", error: Error): boolean
  • emit(event: "message", data: string): boolean
  • emit(event: "close", code?: undefined | number, reason?: undefined | string): boolean
  • emit(event: "ping" | "pong", data?: Buffer): boolean
  • emit(event: "will" | "wont" | "do" | "dont", option: number): boolean
  • emit(event: "subnegotiation", option: number, data: Buffer): boolean
  • emit(event: "telnet", ev: _Telnet.TelnetEvent): boolean
  • emit(event: "open"): boolean
  • emit(event: "gmcp", namespace: string, data: {}): boolean
  • Parameters

    • event: "error"
    • error: Error

    Returns boolean

  • Parameters

    • event: "message"
    • data: string

    Returns boolean

  • Parameters

    • event: "close"
    • Optional code: undefined | number
    • Optional reason: undefined | string

    Returns boolean

  • Parameters

    • event: "ping" | "pong"
    • Optional data: Buffer

    Returns boolean

  • Parameters

    • event: "will" | "wont" | "do" | "dont"
    • option: number

    Returns boolean

  • Parameters

    • event: "subnegotiation"
    • option: number
    • data: Buffer

    Returns boolean

  • Parameters

    • event: "telnet"
    • ev: _Telnet.TelnetEvent

    Returns boolean

  • Parameters

    • event: "open"

    Returns boolean

  • Parameters

    • event: "gmcp"
    • namespace: string
    • data: {}
      • [key: string]: any

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "error", listener: (error: Error) => void): this
  • on(event: "message", listener: (data: string) => void): this
  • on(event: "close", listener: (code?: undefined | number, reason?: undefined | string) => void): this
  • on(event: "ping" | "pong", listener: (data?: Buffer) => void): this
  • on(event: "will" | "wont" | "do" | "dont", listener: (option: number) => void): this
  • on(event: "subnegotiation", listener: (option: number, data: Buffer) => void): this
  • on(event: "telnet", listener: (ev: _Telnet.TelnetEvent) => void): this
  • on(event: "open", listener: () => void): this
  • on(event: "gmcp", listener: (namespace: string, data: {}) => void): this
  • Parameters

    • event: "error"
    • listener: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: (data: string) => void
        • (data: string): void
        • Parameters

          • data: string

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: (code?: undefined | number, reason?: undefined | string) => void
        • (code?: undefined | number, reason?: undefined | string): void
        • Parameters

          • Optional code: undefined | number
          • Optional reason: undefined | string

          Returns void

    Returns this

  • Parameters

    • event: "ping" | "pong"
    • listener: (data?: Buffer) => void
        • (data?: Buffer): void
        • Parameters

          • Optional data: Buffer

          Returns void

    Returns this

  • Parameters

    • event: "will" | "wont" | "do" | "dont"
    • listener: (option: number) => void
        • (option: number): void
        • Parameters

          • option: number

          Returns void

    Returns this

  • Parameters

    • event: "subnegotiation"
    • listener: (option: number, data: Buffer) => void
        • (option: number, data: Buffer): void
        • Parameters

          • option: number
          • data: Buffer

          Returns void

    Returns this

  • Parameters

    • event: "telnet"
    • listener: (ev: _Telnet.TelnetEvent) => void
        • (ev: _Telnet.TelnetEvent): void
        • Parameters

          • ev: _Telnet.TelnetEvent

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: () => void
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "gmcp"
    • listener: (namespace: string, data: {}) => void
        • (namespace: string, data: {}): void
        • Parameters

          • namespace: string
          • data: {}
            • [key: string]: any

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prompt

  • prompt(message: string, mask?: boolean): Promise<string>
  • Parameters

    • message: string
    • Default value mask: boolean = false

    Returns Promise<string>

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send

  • send(data: Buffer): void
  • send(data: string): void

sendGMCP

  • sendGMCP(namespace: string, data: string): void
  • sendGMCP(namespace: string, data: {}): void
  • Parameters

    • namespace: string
    • data: string

    Returns void

  • Parameters

    • namespace: string
    • data: {}
      • [key: string]: any

    Returns void

sendSubnegotiation

  • sendSubnegotiation(option: _Telnet.TelnetOption, data: Buffer): void
  • sendSubnegotiation(option: _Telnet.TelnetOption, data: string): void
  • Parameters

    • option: _Telnet.TelnetOption
    • data: Buffer

    Returns void

  • Parameters

    • option: _Telnet.TelnetOption
    • data: string

    Returns void

Private sendTelnet

  • sendTelnet(command: _Telnet.TelnetNegotiation, option: _Telnet.TelnetOption, data?: Buffer): void
  • Parameters

    • command: _Telnet.TelnetNegotiation
    • option: _Telnet.TelnetOption
    • Optional data: Buffer

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

will

  • will(option: _Telnet.TelnetOption): void
  • Parameters

    • option: _Telnet.TelnetOption

    Returns void

wont

  • wont(option: _Telnet.TelnetOption): void
  • Parameters

    • option: _Telnet.TelnetOption

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc