Skip to content

Commit 2dfda0d

Browse files
committed
docs: add docs for Redis options
1 parent b221c4e commit 2dfda0d

12 files changed

Lines changed: 1274 additions & 1135 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ new Redis("redis://:authpassword@127.0.0.1:6380/4");
189189
new Redis("redis://username:authpassword@127.0.0.1:6380/4");
190190
```
191191

192-
See [API Documentation](API.md#new-redisport-host-options) for all available options.
192+
See [API Documentation](http://luin.github.io/ioredis/classes/index.html#RedisOptions) for all available options.
193193

194194
## Pub/Sub
195195

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/Cluster.html

Lines changed: 558 additions & 558 deletions
Large diffs are not rendered by default.

docs/classes/default.html

Lines changed: 558 additions & 558 deletions
Large diffs are not rendered by default.

docs/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/interfaces/CommonRedisOptions.html

Lines changed: 46 additions & 0 deletions
Large diffs are not rendered by default.

docs/interfaces/SentinelAddress.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/interfaces/SentinelConnectionOptions.html

Lines changed: 5 additions & 0 deletions
Large diffs are not rendered by default.

lib/cluster/ClusterOptions.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -189,13 +189,6 @@ export interface ClusterOptions extends CommanderOptions {
189189
*/
190190
autoPipeliningIgnoredCommands?: string[];
191191

192-
/**
193-
* See Redis class.
194-
*
195-
* @default 60000
196-
*/
197-
maxScriptsCachingTime?: number;
198-
199192
/**
200193
* Custom LUA commands
201194
*/
@@ -221,5 +214,4 @@ export const DEFAULT_CLUSTER_OPTIONS: ClusterOptions = {
221214
dnsLookup: lookup,
222215
enableAutoPipelining: false,
223216
autoPipeliningIgnoredCommands: [],
224-
maxScriptsCachingTime: 60000,
225217
};

lib/connectors/SentinelConnector/index.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,13 @@ type PreferredSlaves =
3232
export { SentinelAddress, SentinelIterator };
3333

3434
export interface SentinelConnectionOptions {
35+
/**
36+
* Master group name of the Sentinel
37+
*/
3538
name?: string;
39+
/**
40+
* @default "master"
41+
*/
3642
role?: "master" | "slave";
3743
tls?: ConnectionOptions;
3844
sentinelUsername?: string;
@@ -48,6 +54,9 @@ export interface SentinelConnectionOptions {
4854
sentinelTLS?: ConnectionOptions;
4955
natMap?: NatMap;
5056
updateSentinels?: boolean;
57+
/**
58+
* @default 10
59+
*/
5160
sentinelMaxConnections?: number;
5261
failoverDetector?: boolean;
5362
}

0 commit comments

Comments
 (0)