Class Name

Index

Constructors

Methods

compress decode encode newCompressionIndex

Constructors

constructor

new Name(): Name
Returns Name

Methods

`Static`compress

compress(
    name: string,
    index: CompressionIndex,
    packetOffset: number,
    isEmail?: boolean,
): Buffer
Compresses the given name using the specified parameters
Parameters
- name: string
- index: CompressionIndex
- packetOffset: number
- isEmail: boolean = false
Returns Buffer

`Static`decode

decode(reader: Reader, isEmail?: boolean, visited?: Set<number>): string
Decodes a name from the byte stream
Parameters
- reader: Reader
- isEmail: boolean = false
- visited: Set<number> = ...
Returns string

`Static`encode

encode(
    writer: Writer,
    name: string,
    index: CompressionIndex,
    isEmail?: boolean,
): void
Encodes the given name with the specified parameters into the given Writer instance
Parameters
- writer: Writer
- name: string
- index: CompressionIndex
- isEmail: boolean = false
Returns void

`Static`newCompressionIndex

newCompressionIndex(): CompressionIndex
Returns a new compression index

Returns CompressionIndex