Skip to content

Commit 896f172

Browse files
Fix example for redis spop function (#1715)
* Fix example for redis spop function * Fix example for redis srandmember function
1 parent 51b4aee commit 896f172

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Removes and returns a random element from the set value stored at `key`.
99

1010
### Parameters
1111

12-
| Parameter | Type | Description |
13-
| :-------- | :----- | :--------------------------------------------- |
14-
| `key` | string | key holding the set to get a random member of. |
12+
| Parameter | Type | Description |
13+
| :-------- | :----- | :------------------------------------------------------- |
14+
| `key` | string | The key value holding the set to get a random member of. |
1515

1616
### Returns
1717

18-
| Type | Resolves with | Rejected when |
19-
| :---------------- | :----------------------------------------------------------- | :---------------------------------------------------------------- |
20-
| `Promise<string>` | On success, the promise resolves to the returned set member. | If the set does not exist, the promise is rejected with an error. |
18+
| Type | Resolves with | Rejected when |
19+
| :---------------- | :----------------------------------------------------------- | :--------------------------------------------------------------- |
20+
| `Promise<string>` | On success, the promise resolves to the returned set member. | If the set doesn't exist, the promise is rejected with an error. |
2121

2222
### Example
2323

@@ -32,7 +32,8 @@ const redisClient = new redis.Client('redis://localhost:6379');
3232
export default async function () {
3333
await redisClient.sadd('myset', 'foo');
3434
await redisClient.sadd('myset', 'bar');
35-
await redisClient.spop('myset', 'foo');
35+
await redisClient.spop('myset');
36+
3637
const members = await redisClient.smembers('myset');
3738
if (members.length !== 1) {
3839
throw new Error('sismember should have length 1');

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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Returns a random element from the set value stored at `key`.
99

1010
### Parameters
1111

12-
| Parameter | Type | Description |
13-
| :-------- | :----- | :--------------------------------------------- |
14-
| `key` | string | key holding the set to get a random member of. |
12+
| Parameter | Type | Description |
13+
| :-------- | :----- | :------------------------------------------------------- |
14+
| `key` | string | The key value holding the set to get a random member of. |
1515

1616
### Returns
1717

18-
| Type | Resolves with | Rejected when |
19-
| :---------------- | :---------------------------------------------------------------- | :---------------------------------------------------------------- |
20-
| `Promise<string>` | On success, the promise resolves with the selected random member. | If the set does not exist, the promise is rejected with an error. |
18+
| Type | Resolves with | Rejected when |
19+
| :---------------- | :---------------------------------------------------------------- | :--------------------------------------------------------------- |
20+
| `Promise<string>` | On success, the promise resolves with the selected random member. | If the set doesn't exist, the promise is rejected with an error. |
2121

2222
### Example
2323

@@ -32,11 +32,10 @@ const redisClient = new redis.Client('redis://localhost:6379');
3232
export default async function () {
3333
await redisClient.sadd('myset', 'foo');
3434
await redisClient.sadd('myset', 'bar');
35-
await redisClient.spop('myset', 'foo');
3635

37-
const members = await redisClient.smembers('myset');
38-
if (members.length !== 1) {
39-
throw new Error('sismember should have length 1');
36+
const randomMember = await redisClient.srandmember('myset');
37+
if (randomMember !== 'foo' && randomMember !== 'bar') {
38+
throw new Error('randomMember should be equal to "foo" or "bar"');
4039
}
4140
}
4241
```

0 commit comments

Comments
 (0)