Socket

Client telnet wrapper for a raw TCP socket.

Hierarchy

EventEmitter
- Socket

Index

Constructors

constructor

Properties

Accessors

binary
gmcp

Methods

Constructors

constructor

new Socket(socket: Socket, options?: OptionMatrix<boolean>): Socket

- Defined in index.ts:285
Parameters
- socket: Socket
- Default value options: OptionMatrix<boolean> = {}
Returns Socket

Properties

Private buffer

buffer: number[] = []

Buffer for incoming data.

Empties when an EOL is encountered, emitting the "data" event.

options

options: OptionMatrix<boolean>

Currently enabled options.

socket: Socket

uuid

uuid: string = v4()

UUID for this socket.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

binary

get binary(): boolean
set binary(value: boolean): void

- Defined in index.ts:431
Get whether this socket is using binary transmission.

Returns boolean
- Defined in index.ts:420
Set whether this socket should use binary transmission.

Parameters
- value: boolean
Returns void

gmcp

get gmcp(): boolean
set gmcp(value: boolean): void

- Defined in index.ts:414
Get whether this socket is using GMCP.

Returns boolean
- Defined in index.ts:403
Set whether this socket should use GMCP.

Parameters
- value: boolean
Returns void

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

destroy

destroy(error?: Error): void

- Defined in index.ts:504
Immediately destroy this socket.

Don't use this

Parameters
- Optional error: Error
  
  Error to throw. Optional.
Returns void

do

do(option: Options): void

- Defined in index.ts:453
Request the client to use an option.

Parameters
- option: Options
  
  The option requested.
Returns void

dont

dont(option: Options): void

- Defined in index.ts:461
Tell the client to no longer use an option.

Parameters
- option: Options
  
  The option to stop using.
Returns void

emit

emit(event: "enabled" | "disabled", option: Options): boolean
emit(event: "message", data: string): boolean
emit(event: "error", error: Error): boolean
emit(event: "data", chunk: Buffer): boolean
emit(event: "close", hadError: boolean): boolean
emit(event: "end" | "connect"): boolean
emit(event: "gmcp", packages: string, obj: object): boolean
emit(event: "will" | "wont" | "do" | "dont", option: Options): boolean
emit(event: "subnegotiation", option: Options, data: Buffer): boolean

Overrides EventEmitter.emit
- Defined in index.ts:510
Enabled or disabled events for specific options when a response is received.

Parameters
- event: "enabled" | "disabled"
- option: Options
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:514
An event with a message received from the other end.

Parameters
- event: "message"
- data: string
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:515
Parameters
- event: "error"
- error: Error
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:519
Raw data from the internal buffer. Stripped of newline and carriage return.

Parameters
- event: "data"
- chunk: Buffer
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:520
Parameters
- event: "close"
- hadError: boolean
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:521
Parameters
- event: "end" | "connect"
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:522
Parameters
- event: "gmcp"
- packages: string
- obj: object
  - [key: string]: any
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:527
Parameters
- event: "will" | "wont" | "do" | "dont"
- option: Options
Returns boolean
Overrides EventEmitter.emit
- Defined in index.ts:532
An out-of-band subnegotiation.

Parameters
- event: "subnegotiation"
- option: Options
- data: Buffer
Returns boolean

end

end(cb?: undefined | function): void

- Defined in index.ts:438
Request the other side of the socket to end transmission, allowing a clean disconnect.

Parameters
- Optional cb: undefined | function
  
  Optional callback.
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:17
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "error", listener: function): this
on(event: "data", listener: function): this
on(event: "close", listener: function): this
on(event: "message", listener: function): this
on(event: "end" | "connect", listener: function): this
on(event: "gmcp", listener: function): this
on(event: "will" | "wont" | "do" | "dont", listener: function): this
on(event: "subnegotiation", listener: function): this
on(event: "enabled" | "disabled", listener: function): this

Overrides EventEmitter.on
- Defined in index.ts:540
Parameters
- event: "error"
- listener: function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:541
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer): void
    - Parameters
      - chunk: Buffer
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:542
Parameters
- event: "close"
- listener: function
  - - (hadError: boolean): void
    - Parameters
      - hadError: boolean
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:543
Parameters
- event: "message"
- listener: function
  - - (message: string): void
    - Parameters
      - message: string
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:544
Parameters
- event: "end" | "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:548
A GMCP packet event.

Parameters
- event: "gmcp"
- listener: function
  - - (packages: string, obj: object): void
    - Parameters
      - packages: string
      - obj: object
        
        [key: string]: any
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:552
Parameters
- event: "will" | "wont" | "do" | "dont"
- listener: function
  - - (option: Options): void
    - Parameters
      - option: Options
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:556
Parameters
- event: "subnegotiation"
- listener: function
  - - (option: Options, data: Buffer): void
    - Parameters
      - option: Options
      - data: Buffer
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in index.ts:563
Enabled or disabled events for specific options when a response is received.

Parameters
- event: "enabled" | "disabled"
- listener: function
  - - (option: Options): void
    - Parameters
      - option: Options
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

setOption

setOption(option: Options, value: boolean): void

- Defined in index.ts:392
Parameters
- option: Options
- value: boolean
Returns void

will

will(option: Options): void

- Defined in index.ts:469
Express willingness to use an option.

Parameters
- option: Options
  
  The option requested.
Returns void

wont

wont(option: Options): void

- Defined in index.ts:477
Refuse to use an option.

Parameters
- option: Options
  
  The option to stop using.
Returns void

write

write(data: string | Buffer, cb?: undefined | function): boolean

- Defined in index.ts:446
Write data to the other end of the socket.

Parameters
- data: string | Buffer
  
  The data to write to the socket.
- Optional cb: undefined | function
  
  Optional callback.
Returns boolean

writeGMCP

writeGMCP(packages: string, data: object): boolean

- Defined in index.ts:486
Send a GMCP packet to the client (if enabled).

Parameters
- packages: string
  
  The package string for this GMCP packet.
- data: object
  
  The object to send.
  - [key: string]: any
Returns boolean

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in E:/Users/erath/Documents/projects/ts-telnet2/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

socket: Socket

Default value options: OptionMatrix<boolean> = {}

Returns Socket

Properties

Private buffer

options

socket

uuid

Static defaultMaxListeners

Accessors

binary

Returns boolean

Parameters

value: boolean

Returns void

gmcp

Returns boolean

Parameters

value: boolean

Returns void

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

destroy

Parameters

Optional error: Error

Returns void

do

Parameters

option: Options

Returns void

dont

Parameters

option: Options

Returns void

emit

Parameters

event: "enabled" | "disabled"

option: Options

Returns boolean

Parameters

event: "message"

data: string

Returns boolean

Parameters

event: "error"

error: Error

Returns boolean

Parameters

event: "data"

chunk: Buffer

Returns boolean

Parameters

event: "close"

hadError: boolean

Returns boolean

Parameters

event: "end" | "connect"

Returns boolean

Parameters

event: "gmcp"

packages: string

obj: object

[key: string]: any

Returns boolean