socket-json-wrapper
Wrapper for socket connections that allows you to send and receive json objects.
Installation
npm i socket-json-wrapper
Usage
In the server.js
file:
const net = const Connection = const server = net
In the client.js
file:
const net = const Connection = const socket = net const connection = socket connection // send some data to the server.connection
API
connection.isDead
<boolean>
Is set to true if the underlying socket is not writable.
connection.socket
A refference to the wrapped socket.
connection.send(data)
- data
<*>
- This may be any value that can by stringified to valid JSON.
It returns a <boolean>
that is true if the data was written to the socket.
connection.close()
This method calls .end()
on the underlying socket.
Typescript usage
In typescript you can define types that can be sent or received. You can do so by creating an interface and by passing it to the Connection when you are creating it.
// Pass interfaces that represent the messages that can be sent or received so you can get completions. connection.on'message', // send some data to the server.connection.send// Typescript will automatically detect if your message does not match the sendable type defined in the interface above.