Class PacketDecoder<ContextType>

Type Parameters

ContextType = any

Hierarchy

PacketDecoder

Index

Methods

clear

clear(): void
Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:34

emit

emit(message: Serializable, direction: MessageDirection, context: ContextType): Promise<void>
Parameters
- message: Serializable
- direction: MessageDirection
- context: ContextType
Returns Promise<void>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:54

emitDecoded

emitDecoded(message: Serializable, direction: MessageDirection, context: ContextType): Promise<void>
Emit a decoded message to all listeners concurrently, also emits the message's children recursively.
Parameters
- message: Serializable
  
  The message to emit.
- direction: MessageDirection
  
  The direction that the message was sent.
- context: ContextType
  
  Additional metadata for the message, e.g. the context.
Returns Promise<void>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:46

emitDecodedSerial

emitDecodedSerial(message: Serializable, direction: MessageDirection, context: ContextType): Promise<void>
Emit a decoded message to all listeners serially, also emits the message's children recursively.
Parameters
- message: Serializable
  
  The message to emit.
- direction: MessageDirection
  
  The direction that the message was sent.
- context: ContextType
  
  Additional metadata for the message, e.g. the context.
Returns Promise<void>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:53

emitSerial

emitSerial(message: Serializable, direction: MessageDirection, context: ContextType): Promise<void>
Parameters
- message: Serializable
- direction: MessageDirection
- context: ContextType
Returns Promise<void>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:55

getListeners

getListeners<T>(messageClass: Deserializable): MessageListener<GetSerialized<T>, ContextType>[]
Get all listeners for a packet.

Returns
All listeners for the packet.
Type Parameters
- T extends Deserializable
Parameters
- messageClass: Deserializable
  
  The packet to get listeners for.
Returns MessageListener<GetSerialized<T>, ContextType>[]
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:61

off

off<T>(messageClass: T, listener: MessageListener<GetSerialized<T>, ContextType>): void
Remove a listener from a message.
Type Parameters
- T extends Deserializable
Parameters
- messageClass: T
  
  The message to listen for.
- listener: MessageListener<GetSerialized<T>, ContextType>
  
  The listener to remove.
Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:81
off<T>(messageClass: T, listener: MessageListener<GetSerialized<T[number]>, ContextType>): void
Remove a listener from several messages being listened to.
Type Parameters
- T extends Deserializable[]
Parameters
- messageClass: T
  
  The message to listen for.
- listener: MessageListener<GetSerialized<T[number]>, ContextType>
  
  The listener to remove.
Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:87

on

on<T>(messageClass: T, listener: MessageListener<GetSerialized<T>, ContextType>): (() => void)
Listen to a message being sent through the decoder.

Returns
A function to remove the listener.
Type Parameters
- T extends Deserializable
Parameters
- messageClass: T
  
  The message to listen for.
- listener: MessageListener<GetSerialized<T>, ContextType>
  
  The callback for when the message is decoded.
Returns (() => void)
- - (): void
  - Listen to a message being sent through the decoder.
    
    Returns
    A function to remove the listener.
    
    Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:68
on<T>(messageClass: T, listener: MessageListener<GetSerialized<T[number]>, ContextType>): (() => void)
Listen to any of several messages being sent through the decoder.

Returns
A function to remove the listener.
Type Parameters
- T extends Deserializable[]
Parameters
- messageClass: T
  
  The messages to listen for.
- listener: MessageListener<GetSerialized<T[number]>, ContextType>
  
  The callback for when one of the messages is decoded.
Returns (() => void)
- - (): void
  - Listen to any of several messages being sent through the decoder.
    
    Returns
    A function to remove the listener.
    
    Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:75

once

once<T>(messageClass: T, listener: MessageListener<GetSerialized<T>, ContextType>): (() => void)
Listen to a message being sent through the decoder once.

Returns
A function to remove the listener.
Type Parameters
- T extends Deserializable
Parameters
- messageClass: T
  
  The message to listen for.
- listener: MessageListener<GetSerialized<T>, ContextType>
  
  The callback for when the message is decoded.
Returns (() => void)
- - (): void
  - Listen to a message being sent through the decoder once.
    
    Returns
    A function to remove the listener.
    
    Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:94
once<T>(messageClass: T, listener: MessageListener<GetSerialized<T[number]>, ContextType>): (() => void)
Listen to any of several messages being sent through the decoder once.

Returns
A function to remove the listener.
Type Parameters
- T extends Deserializable[]
Parameters
- messageClass: T
  
  The messages to listen for.
- listener: MessageListener<GetSerialized<T[number]>, ContextType>
  
  The callback for when one of the messages is decoded.
Returns (() => void)
- - (): void
  - Listen to any of several messages being sent through the decoder once.
    
    Returns
    A function to remove the listener.
    
    Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:101

parse

parse(reader: HazelReader | Buffer, direction?: MessageDirection): null | Serializable
Parse a buffer or reader in place, without emitting the resultant message.

Returns
The parsed message.
Parameters
- reader: HazelReader | Buffer
  
  The buffer or reader to parse.
- Optional direction: MessageDirection
  
  The direction that the packet was sent.
Returns null | Serializable
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:137

register

register(...messageClasses: Deserializable[]): void
Register a message or several messages to the packet decoder.
Parameters
- Rest ...messageClasses: Deserializable[]
  
  The packet or packets to register.
Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:39

reset

reset(): void
Reset the packet decoder, removing all custom packets and removing listeners.

Returns void
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:33

wait

wait<T>(messageClass: T): Promise<{
    context: ContextType;
    direction: MessageDirection;
    message: GetSerialized<T>;
}>
Asynchronously wait for a message to be decoded.

Returns
A promise containing the message, direciton and context metadata for the message.
Type Parameters
- T extends Deserializable
Parameters
- messageClass: T
  
  The message to listen for.
Returns Promise<{
    context: ContextType;
    direction: MessageDirection;
    message: GetSerialized<T>;
}>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:107

waitf

waitf<T>(messageClass: T, filter: ((message: GetSerialized<T>, direction: MessageDirection, context: ContextType) => boolean)): Promise<{
    context: ContextType;
    direction: MessageDirection;
    message: GetSerialized<T>;
}>
Asynchronously wait for a specific message to be decoded.

Returns
A function to remove the listener.
Type Parameters
- T extends Deserializable
Parameters
- messageClass: T
  
  The message to listen for.
- filter: ((message: GetSerialized<T>, direction: MessageDirection, context: ContextType) => boolean)
  
  A filter for the message to wait for.
  - - (message: GetSerialized<T>, direction: MessageDirection, context: ContextType): boolean
    - Parameters
      
      message: GetSerialized<T>
      
      direction: MessageDirection
      
      context: ContextType
      
      Returns boolean
Returns Promise<{
    context: ContextType;
    direction: MessageDirection;
    message: GetSerialized<T>;
}>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:118

write

write(reader: HazelReader | Buffer, direction: undefined | MessageDirection, context: ContextType): Promise<null | Serializable>
Write a buffer or reader to the decoder.
Parameters
- reader: HazelReader | Buffer
  
  The buffer or reader to decode.
- direction: undefined | MessageDirection
  
  The direction that the packet was sent.
- context: ContextType
  
  Additional metadata for the context.
Returns Promise<null | Serializable>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:130

Properties

config

config: PacketDecoderConfig

listeners

listeners: Map<`${string}:${number}`, MessageListener<Serializable, ContextType>[]>

types

types: Map<`${string}:${number}`, Deserializable>

Constructors

constructor

new PacketDecoder<ContextType>(config?: Partial<PacketDecoderConfig>): PacketDecoder<ContextType>
Type Parameters
- ContextType = any
Parameters
- Optional config: Partial<PacketDecoderConfig>
Returns PacketDecoder<ContextType>
- Defined in node_modules/@skeldjs/protocol/dist/lib/PacketDecoder.d.ts:29

Class PacketDecoder<ContextType>

Type Parameters

ContextType = any

Hierarchy

Index

Methods

Properties

Constructors

Methods

clear

Returns void

emit

Parameters

message: Serializable

direction: MessageDirection

context: ContextType

Returns Promise<void>

emitDecoded

Parameters

message: Serializable

direction: MessageDirection

context: ContextType

Returns Promise<void>

emitDecodedSerial

Parameters

message: Serializable

direction: MessageDirection

context: ContextType

Returns Promise<void>

emitSerial

Parameters

message: Serializable

direction: MessageDirection

context: ContextType

Returns Promise<void>

getListeners

Returns

Type Parameters

T extends Deserializable

Parameters

messageClass: Deserializable

Returns MessageListener<GetSerialized<T>, ContextType>[]

off

Type Parameters

T extends Deserializable

Parameters

messageClass: T

listener: MessageListener<GetSerialized<T>, ContextType>

Returns void

Type Parameters

T extends Deserializable[]

Parameters

messageClass: T

listener: MessageListener<GetSerialized<T[number]>, ContextType>

Returns void

on

Returns

Type Parameters

T extends Deserializable

Parameters

messageClass: T

listener: MessageListener<GetSerialized<T>, ContextType>

Returns (() => void)

Returns

Returns void

Returns

Type Parameters

T extends Deserializable[]

Parameters

messageClass: T

listener: MessageListener<GetSerialized<T[number]>, ContextType>

Returns (() => void)

Returns

Returns void

once

Returns

Type Parameters

T extends Deserializable

Parameters

messageClass: T

`Optional` direction: MessageDirection

`Rest` ...messageClasses: Deserializable[]

Returns Promise<{
context: ContextType;
direction: MessageDirection;
message: GetSerialized<T>;
}>

Returns Promise<{
context: ContextType;
direction: MessageDirection;
message: GetSerialized<T>;
}>

`Optional` config: Partial<PacketDecoderConfig>