Class IPCMessage

Hierarchy (view full)

IPCBaseMessage
- IPCMessage

Index

Constructors

Properties

data error? instance nonce type

Methods

reply request send toJSON

Constructors

constructor

new IPCMessage(instance, message): IPCMessage
Parameters
- instance: ClusterShard<ClusterShardClient> | Cluster
- message: IPCRawMessage
Returns IPCMessage
Overrides IPCBaseMessage.constructor
- Defined in src/ipc/IPCMessage.ts:45

Properties

data

data: IPCMessageData

Message data.

`Optional` error

error?: MakeErrorOptions

Message error data.

instance

instance: ClusterShard<ClusterShardClient> | Cluster

nonce

nonce: string

Message nonce.

type

type: IPCMessageType

Message type.

Methods

reply

reply(data): Promise<void>
Sends a reply to instance.
Parameters
- data: IPCMessageData
  Message data.
Returns Promise<void>
- Defined in src/ipc/IPCMessage.ts:79

request

request(data): Promise<void>
Sends a request to instance.
Parameters
- data: IPCMessageData
  Message data.
Returns Promise<void>
- Defined in src/ipc/IPCMessage.ts:66

send

send(data): Promise<void>
Sends a message to instance.
Parameters
- data: IPCMessageData
  Message data.
Returns Promise<void>
- Defined in src/ipc/IPCMessage.ts:53

toJSON

toJSON(): IPCRawMessage
Serializes the message to JSON.

Returns IPCRawMessage
Inherited from IPCBaseMessage.toJSON
- Defined in src/ipc/IPCMessage.ts:39

Generated using TypeDoc