Module Util

A utility namespace containing helper functions for the library.

Index

Functions

Functions

isEOL

isEOL(buffer: Buffer): boolean

- Defined in index.ts:146
Checks a buffer for an End of Line (\n | \r\n).

Parameters
- buffer: Buffer
  
  The buffer to check for EOL.
Returns boolean

parseSB

parseSB(buffer: Buffer): ISBParse

- Defined in index.ts:164
Parses a subnegotiation sequence into the option and data.

Parameters
- buffer: Buffer
  
  The buffer to parse.
Returns ISBParse

splitIAC

splitIAC(buffer: Buffer): Buffer[]

- Defined in index.ts:176
Splits a buffer into individual IAC sequences.

Parameters
- buffer: Buffer
  
  The input buffer.
Returns Buffer[]

stripEOL

stripEOL(buffer: Buffer): Buffer

- Defined in index.ts:153
Strips EOL from the end of a buffer.

Parameters
- buffer: Buffer
  
  The buffer input.
Returns Buffer

writeIAC

writeIAC(negotiate: Negotiation, option: Options): Buffer

- Defined in index.ts:114
Creates a buffer containing an IAC sequence.

Parameters
- negotiate: Negotiation
  
  The negotiation byte for this IAC sequence.
- option: Options
  
  The option byte for this IAC sequence.
Returns Buffer

writeSB

writeSB(option: Options, data: string): Buffer

- Defined in index.ts:122
Creates a buffer containing a subnegotiation sequence.

Parameters
- option: Options
  
  The option byte for this subnegotiation sequence.
- data: string
  
  The data for this subnegotiation sequence.
Returns Buffer

Generated using TypeDoc