Troplo/node-ipc
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Wiki Activity

Merge pull request #130 from 0x5e/patch-1

Browse source 
Add documentation of `delimiter` variable
This commit is contained in:
Brandon Nozaki Miller 2017-10-26 13:02:52 -07:00 committed by GitHub
commit 70e03c119b
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -98,6 +98,7 @@ Set these variables in the `ipc.config` scope to overwrite or set default values
networkPort : 8000, networkPort : 8000,
encoding : 'utf8', encoding : 'utf8',
rawBuffer : false, rawBuffer : false,
delimiter : '\f',
sync : false, sync : false,
silent : false, silent : false,
logInColor : true, logInColor : true,
@ -128,6 +129,7 @@ Set these variables in the `ipc.config` scope to overwrite or set default values
| networkPort| the default port on which TCP, TLS, or UDP sockets should connect | | networkPort| the default port on which TCP, TLS, or UDP sockets should connect |
| encoding | the default encoding for data sent on sockets. Mostly used if rawBuffer is set to true. Valid values are : ` ascii` ` utf8 ` ` utf16le` ` ucs2` ` base64` ` hex ` . | | encoding | the default encoding for data sent on sockets. Mostly used if rawBuffer is set to true. Valid values are : ` ascii` ` utf8 ` ` utf16le` ` ucs2` ` base64` ` hex ` . |
| rawBuffer| if true, data will be sent and received as a raw node ` Buffer ` __NOT__ an ` Object ` as JSON. This is great for Binary or hex IPC, and communicating with other processes in languages like C and C++ | | rawBuffer| if true, data will be sent and received as a raw node ` Buffer ` __NOT__ an ` Object ` as JSON. This is great for Binary or hex IPC, and communicating with other processes in languages like C and C++ |
| delimiter| the delimiter at the end of each data packet. |
| sync | synchronous requests. Clients will not send new requests until the server answers. | | sync | synchronous requests. Clients will not send new requests until the server answers. |
| silent | turn on/off logging default is false which means logging is on | | silent | turn on/off logging default is false which means logging is on |
| logInColor | turn on/off util.inspect colors for ipc.log | | logInColor | turn on/off util.inspect colors for ipc.log |