From 35ac068ab4eb7860b82d3f21d1887a84040313b4 Mon Sep 17 00:00:00 2001 From: Kirby Banman Date: Thu, 26 Jun 2014 02:10:40 -0700 Subject: [PATCH] include unix domain socket config object example --- Client.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/Client.md b/Client.md index 5919a57..d81d0d2 100644 --- a/Client.md +++ b/Client.md @@ -63,7 +63,7 @@ Creates a new, unconnected instance of a Client configured via supplied configur - whether to try SSL/TLS to connect to server -#### example +#### tcp example ```javascript var client = new Client({ @@ -75,6 +75,20 @@ Creates a new, unconnected instance of a Client configured via supplied configur }); ``` +#### domain socket example + +Will look for the Unix Domain Socket at `/tmp/.s.PGSQL.5313` and connect with the rest of the supplied credentials: + +```javascript + var client = new Client({ + user: 'brianc', + password: 'boom!', + database: 'test', + host: '/tmp', + port: 5313 + }); +``` + ## Methods