Class NodeMessage

Hierarchy

NodeMessage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NodeMessage(client: SocketHandler, id: number, receptive: boolean, data: any): NodeMessage

- Defined in src/lib/Structures/NodeMessage.ts:37
since
0.0.1

Parameters
- client: SocketHandler
  
  The socket that received this message.
- id: number
  
  The ID of the message.
- receptive: boolean
  
  Whether or not this message accepts a reply.
- data: any
  
  The data received from the socket.
Returns NodeMessage

Properties

Readonly client

client: SocketHandler

The client that received this message.

since: 0.0.1

data

data: any

The data received from the socket.

since: 0.0.1

Readonly id

id: number

The id of this message.

since: 0.0.1

Readonly receptive

receptive: boolean

Whether the message is receptive or not.

since: 0.0.1

Methods

freeze

freeze(): Readonly<NodeMessage>

- Defined in src/lib/Structures/NodeMessage.ts:62
Freeze the message.

since
0.0.1

Returns Readonly<NodeMessage>

reply

reply(content: unknown): void

- Defined in src/lib/Structures/NodeMessage.ts:52
Reply to the socket.

since
0.0.1

Parameters
- content: unknown
  
  The content to send.
Returns void

toJSON

toJSON(): { data: any; id: number; receptive: boolean }

- Defined in src/lib/Structures/NodeMessage.ts:70
The toJSON overload for JSON.stringify.

since
0.0.1

Returns { data: any; id: number; receptive: boolean }
- data: any
- id: number
- receptive: boolean

toString

toString(): string

- Defined in src/lib/Structures/NodeMessage.ts:82
The toString overload for string casting.

since
0.0.1

Returns string

Generated using TypeDoc