Skip to content

Commit

Permalink
clarifies createClient in README as per redis#781
Browse files Browse the repository at this point in the history
  • Loading branch information
stockholmux committed Jul 16, 2015
1 parent 5eb98e4 commit dc461f0
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,17 @@ resume sending when you get `drain`.
`client` will emit `idle` when there are no outstanding commands that are awaiting a response.

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

### overloading
* redis.createClient() = redis.createClient(6379, '127.0.0.1', {})
* redis.createClient(options) = redis.createClient(6379, '127.0.0.1', options)
* redis.createClient(unix_socket, options)
* redis.createClient(port, host, options)
* `redis.createClient(port,host,options)`
* `redis.createClient()` is equivalent to `redis.createClient(6379, '127.0.0.1', {})`
* `redis.createClient(options)` is equivalent to `redis.createClient(6379, '127.0.0.1', options)`
* `redis.createClient(unix_socket, options)`
* `redis.createClient(port, host, options)`

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

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

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


## client.auth(password, callback)
Expand Down

0 comments on commit dc461f0

Please sign in to comment.