From 2dca400678213abdcc2f76eab02269b724813aa2 Mon Sep 17 00:00:00 2001 From: gaosen <0x5e@sina.cn> Date: Wed, 25 Oct 2017 21:05:22 +0100 Subject: [PATCH] Update README.md Add documentation of `delimiter` variable --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 54f1f5e..8398681 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,7 @@ Set these variables in the `ipc.config` scope to overwrite or set default values networkPort : 8000, encoding : 'utf8', rawBuffer : false, + delimiter : '\f', sync : false, silent : false, 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 | | 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++ | +| delimiter| the delimiter at the end of each data packet. | | 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 | | logInColor | turn on/off util.inspect colors for ipc.log |