Constructor
new Message(optionsopt)
- Source:
Creates an instance of Message.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
options object Properties
|
Members
decoder
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
decoder |
function | function |
delimiter
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
Namespace |
String | delimiter |
encoder
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
encoder |
function | function |
Methods
decode(data) → {any}
- Source:
Decode data
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Buffer |
Returns:
- Type
- any
encode(data) → {Buffer}
- Source:
Encode data
Parameters:
| Name | Type | Description |
|---|---|---|
data |
any |
Returns:
- Type
- Buffer
pack(namespace, payload) → {Buffer}
- Source:
Pack a message
Parameters:
| Name | Type | Description |
|---|---|---|
namespace |
String | namespace of the message |
payload |
any | payload of the message |
Returns:
Encoded namespace and payload
- Type
- Buffer
unpack(data) → {message}
- Source:
Unpack a message
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Buffer |
Returns:
- Type
- message