Skip to content

Commit dc461f0

Browse files
committed
clarifies createClient in README as per #781
1 parent 5eb98e4 commit dc461f0

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,17 @@ resume sending when you get `drain`.
144144
`client` will emit `idle` when there are no outstanding commands that are awaiting a response.
145145

146146
## redis.createClient()
147+
If you have `redis-server` running on the same computer as node, then the defaults for
148+
port and host are probably fine and you don't need to supply any arguments. `createClient()` returns a `RedisClient`.
147149

148150
### overloading
149-
* redis.createClient() = redis.createClient(6379, '127.0.0.1', {})
150-
* redis.createClient(options) = redis.createClient(6379, '127.0.0.1', options)
151-
* redis.createClient(unix_socket, options)
152-
* redis.createClient(port, host, options)
151+
* `redis.createClient(port,host,options)`
152+
* `redis.createClient()` is equivalent to `redis.createClient(6379, '127.0.0.1', {})`
153+
* `redis.createClient(options)` is equivalent to `redis.createClient(6379, '127.0.0.1', options)`
154+
* `redis.createClient(unix_socket, options)`
155+
* `redis.createClient(port, host, options)`
153156

154-
If you have `redis-server` running on the same computer as node, then the defaults for
155-
port and host are probably fine. `options` in an object with the following possible properties:
157+
`options` in an object with the following possible properties:
156158

157159
* `parser`: which Redis protocol reply parser to use. Defaults to `hiredis` if that module is installed.
158160
This may also be set to `javascript`.
@@ -205,7 +207,6 @@ You can force an IPv6 if you set the family to 'IPv6'. See nodejs net or dns mod
205207
client.end();
206208
```
207209

208-
`createClient()` returns a `RedisClient` object that is named `client` in all of the examples here.
209210

210211

211212
## client.auth(password, callback)

0 commit comments

Comments
 (0)