Skip to content

Commit 040f59a

Browse files
Apply suggestions from code review
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
1 parent 3202b72 commit 040f59a

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/sources/next/javascript-api/k6-experimental/redis/client/_index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ weight: 10
77

88
# Client
99

10-
`Client` is a [Redis](https://redis.io) client to interact with a Redis server, sentinel or cluster. It exposes a promise-based API, which users can interact with in an asynchronous manner.
10+
`Client` is a [Redis](https://redis.io) client to interact with a Redis server, sentinel, or cluster. It exposes a promise-based API, which users can interact with in an asynchronous manner.
1111

1212
Though the API intends to be thorough and extensive, it does not expose the whole Redis API. Instead, the intent is to expose Redis for use cases most appropriate to k6.
1313

1414
## Usage
1515

1616
### Single-node server
1717

18-
As shown in the above example, the simplest way to create a new `Client` instance that connects to a single Redis server is by passing a URL string.
18+
You can create a new `Client` instance that connects to a single Redis server by passing a URL string.
1919
It must be in the format:
2020

21-
`redis[s]://[[username][:password]@][host][:port][/db-number]`
21+
```
22+
redis[s]://[[username][:password]@][host][:port][/db-number]
23+
```
2224

2325
Here's an example of a URL string that connects to a Redis server running on localhost, on the default port (6379), and using the default database (0):
2426

@@ -53,7 +55,7 @@ const client = new redis.Client({
5355

5456
### TLS
5557

56-
A TLS connection can be established in a couple of ways.
58+
You can configure a TLS connection in a couple of ways.
5759

5860
If the server has a certificate signed by a public Certificate Authority, you can use the `rediss` URL scheme:
5961

@@ -87,7 +89,7 @@ const client = new redis.Client({
8789

8890
{{< /code >}}
8991

90-
Note that for self-signed certificates, k6's [**insecureSkipTLSVerify**](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/k6-options/reference/#insecure-skip-tls-verify) option must be enabled (set to `true`).
92+
Note that for self-signed certificates, k6's [insecureSkipTLSVerify](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/k6-options/reference/#insecure-skip-tls-verify) option must be enabled (set to `true`).
9193

9294
#### TLS client authentication (mTLS)
9395

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Options'
3-
excerpt: 'Options allow to fine tune how a Redis client behaves and interacts with a Redis server or cluster.'
3+
excerpt: 'Options allow you to fine-tune how a Redis client behaves and interacts with a Redis server or cluster.'
44
weight: 20
55
---
66

0 commit comments

Comments
 (0)