Skip to content

Commit 3202b72

Browse files
oleiadeheitortsergent
oleiade
and
heitortsergent
authored
Apply suggestions from code review
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
1 parent 5f5c26f commit 3202b72

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

‎docs/sources/next/javascript-api/k6-experimental/redis/redis-options.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ weight: 20
66

77
# Redis options
88

9-
You can configure the [Redis Client](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/redis/client) either by using a Redis connection URL as demonstrated in the [client documentation](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/redis/client#usage) or using an [Options](#options) object to access more advanced configuration.
9+
You can configure the [Redis Client](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/redis/client) by using a Redis connection URL as demonstrated in the [client documentation](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/redis/client#usage), or by using an [Options](#options) object to access more advanced configuration.
1010

1111
## Options
1212

13-
Configuration for the overall Redis client, including authentication and connection settings.
13+
The configuration for the overall Redis client, including authentication and connection settings.
1414

1515
| Option Name | Type | Description |
1616
| ---------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------- |
17-
| socket | [SocketOptions](#socket-connection-options-socketoptions) | Configuration of connection socket used to connect to the redis server. |
17+
| socket | [SocketOptions](#socket-connection-options) | The configuration of the connection socket used to connect to the Redis server. |
1818
| username | String (optional) | Username for client authentication. |
1919
| password | String (optional) | Password for client authentication. |
2020
| clientName | String (optional) | Name for the client connection. |
2121
| database | Number (optional) | Database ID to select after connecting. |
2222
| masterName | String (optional) | Master instance name for Sentinel. |
2323
| sentinelUsername | String (optional) | Username for Sentinel authentication. |
2424
| sentinelPassword | String (optional) | Password for Sentinel authentication. |
25-
| cluster | [ClusterOptions](#redis-cluster-options-clusteroptions) (optional) | Configuration for Redis Cluster connections. |
25+
| cluster | [ClusterOptions](#redis-cluster-options) (optional) | The configuration for Redis Cluster connections. |
2626

2727
### Socket Connection Options
2828

@@ -32,16 +32,16 @@ Socket-level settings for connecting to a Redis server.
3232
| ------------------ | -------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
3333
| host | String | IP address or hostname of the Redis server. |
3434
| port | Number (optional) | Port number of the Redis server. |
35-
| tls | [TLSOptions](#tls-configuration-options-tlsoptions) (optional) | Configuration for TLS/SSL. |
36-
| dialTimeout | Number (optional, default is _5(seconds)_) | Timeout for establishing a connection, expressed in seconds. |
37-
| readTimeout | Number (optional, default is _3(seconds)_) | Timeout for socket reads, expressed in seconds. A value of `-1` disables the timeout. |
38-
| writeTimeout | Number (optional, default is `readTimeout`) | Timeout for socket writes, expressed in seconds. A value of `-1` disables the timeout. |
39-
| poolSize | Number (optional, default is _10 (per CPU)_) | Number of socket connections in the pool per CPU. |
35+
| tls | [TLSOptions](#tls-configuration-options) (optional) | The configuration for TLS/SSL. |
36+
| dialTimeout | Number (optional, default is _5_ (seconds)) | Timeout for establishing a connection, in seconds. |
37+
| readTimeout | Number (optional, default is _3_ (seconds)) | Timeout for socket reads, in seconds. A value of `-1` disables the timeout. |
38+
| writeTimeout | Number (optional, default is `readTimeout`) | Timeout for socket writes, in seconds. A value of `-1` disables the timeout. |
39+
| poolSize | Number (optional, default is _10_ (per CPU)) | Number of socket connections in the pool per CPU. |
4040
| minIdleConns | Number (optional) | Minimum number of idle connections in the pool. |
4141
| maxConnAge | Number (optional, default is _0_ (no maximum idle time)) | Maximum idle time before closing a connection. |
4242
| poolTimeout | Number (optional, `readTimeout + 1`) | Timeout for acquiring a connection from the pool. |
4343
| idleTimeout | Number (optional, `readTimeout + 1`) | Timeout for idle connections in the pool. |
44-
| idleCheckFrequency | Number (optional, default is _1 (minute)_) | Frequency of idle connection checks, in minutes. A value of `-1` disables the checks. |
44+
| idleCheckFrequency | Number (optional, default is _1_ (minute)) | Frequency of idle connection checks, in minutes. A value of `-1` disables the checks. |
4545

4646
#### TLS Configuration Options
4747

@@ -63,4 +63,4 @@ Options for behavior in a Redis Cluster setup.
6363
| readOnly | Boolean (optional) | Enables read-only mode for replicas. |
6464
| routeByLatency | Boolean (optional) | Route read commands by latency. |
6565
| routeRandomly | Boolean (optional) | Random routing for read commands. |
66-
| nodes | String[] or [SocketOptions](#socket-connection-options-socketoptions)[] | List of cluster nodes as URLs or [SocketOptions](#socket-connection-options-socketoptions). |
66+
| nodes | String[] or [SocketOptions](#socket-connection-options)[] | List of cluster nodes as URLs or [SocketOptions](#socket-connection-options). |

0 commit comments

Comments
 (0)