Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brantstuns committed Apr 12, 2017
1 parent 4cfbe5e commit b5b6277
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ npm i cache-out --save

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| requestMethod | function | _required_ | the function that you would be replacing cache-out with (ex [request-promise-native](https://github.com/request/request-promise-native)) |
| requestMethod | function | _required_ | the function that you would be replacing cache-out with ([request-promise](https://github.com/request/request-promise)) |
| requestOptions | object | _required_ | the options object you would be passing to the function above |
| redisOptions | object | If no argument is passed a default ioredis client will be created | this is not required but if you want to specify you're redis setup (which you definitely are going to have to do at some point) then make sure it follows the [options object](https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options) specified for ioredis. Alternatively, you can pass in a pre instantiated redis client here too! Cache-out will use the passed in client if this is the case. |
| secondsToCache | number | 86400 (which 24 hours in seconds) | The amount of time in seconds you want to cache the response in redis for |
Expand Down

0 comments on commit b5b6277

Please sign in to comment.