Skip to content

Commit a69a9b4

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

File tree

8 files changed

+2
-27
lines changed

8 files changed

+2
-27
lines changed

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/_index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ KinesisClient methods will throw errors in case of failure.
3737

3838
### Examples
3939

40-
{{< code >}}
4140

4241
<!-- md-k6:skip -->
4342

@@ -102,11 +101,9 @@ export default async function () {
102101
}
103102
```
104103

105-
{{< /code >}}
106104

107105
#### Stream management
108106

109-
{{< code >}}
110107

111108
<!-- md-k6:skip -->
112109

@@ -144,4 +141,3 @@ export default async function () {
144141
}
145142
```
146143

147-
{{< /code >}}

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/createStream.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'createStream'
3-
head_title: 'KinesisClient.createStream(streamName, [options])'
43
description: 'KinesisClient.createStream creates a new Kinesis stream'
54
weight: 10
65
---
@@ -32,7 +31,6 @@ weight: 10
3231

3332
### Example
3433

35-
{{< code >}}
3634

3735
<!-- md-k6:skip -->
3836

@@ -65,4 +63,3 @@ export default async function () {
6563
}
6664
```
6765

68-
{{< /code >}}

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/deleteStream.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'deleteStream'
3-
head_title: 'KinesisClient.deleteStream(streamName)'
43
description: 'KinesisClient.deleteStream deletes a Kinesis stream'
54
weight: 10
65
---
@@ -23,7 +22,6 @@ weight: 10
2322

2423
### Example
2524

26-
{{< code >}}
2725

2826
<!-- md-k6:skip -->
2927

@@ -50,4 +48,3 @@ export default async function () {
5048
}
5149
```
5250

53-
{{< /code >}}

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/getRecords.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'getRecords'
3-
head_title: 'KinesisClient.getRecords(shardIterator, [options])'
43
description: 'KinesisClient.getRecords gets records from a Kinesis stream shard'
54
weight: 10
65
---
@@ -47,7 +46,6 @@ weight: 10
4746

4847
### Example
4948

50-
{{< code >}}
5149

5250
<!-- md-k6:skip -->
5351

@@ -115,4 +113,3 @@ export default async function () {
115113
}
116114
```
117115

118-
{{< /code >}}

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/getShardIterator.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'getShardIterator'
3-
head_title: 'KinesisClient.getShardIterator(streamName, shardId, shardIteratorType, [options])'
43
description: 'KinesisClient.getShardIterator gets a shard iterator for reading records from a Kinesis stream'
54
weight: 10
65
---
@@ -32,8 +31,8 @@ weight: 10
3231

3332
| Parameter | Type | Description |
3433
| :--------------------- | :----- | :--------------------------------------------------------------------------------------------------- |
35-
| startingSequenceNumber | string | The sequence number to start from (required for AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER types). |
36-
| timestamp | Date | The timestamp to start from (required for AT_TIMESTAMP type). |
34+
| startingSequenceNumber | string | The sequence number to start from (required for `AT_SEQUENCE_NUMBER` and `AFTER_SEQUENCE_NUMBER` types). |
35+
| timestamp | Date | The timestamp to start from (required for `AT_TIMESTAMP` type). |
3736

3837
### Returns
3938

@@ -49,7 +48,6 @@ weight: 10
4948

5049
### Example
5150

52-
{{< code >}}
5351

5452
<!-- md-k6:skip -->
5553

@@ -111,4 +109,3 @@ export default async function () {
111109
}
112110
```
113111

114-
{{< /code >}}

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/listShards.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'listShards'
3-
head_title: 'KinesisClient.listShards(streamName, [options])'
43
description: 'KinesisClient.listShards lists shards in a Kinesis stream'
54
weight: 10
65
---
@@ -49,7 +48,6 @@ weight: 10
4948

5049
### Example
5150

52-
{{< code >}}
5351

5452
<!-- md-k6:skip -->
5553

@@ -99,4 +97,3 @@ export default async function () {
9997
}
10098
```
10199

102-
{{< /code >}}

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/listStreams.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'listStreams'
3-
head_title: 'KinesisClient.listStreams([options])'
43
description: 'KinesisClient.listStreams lists Kinesis streams'
54
weight: 10
65
---
@@ -37,7 +36,6 @@ weight: 10
3736

3837
### Example
3938

40-
{{< code >}}
4139

4240
<!-- md-k6:skip -->
4341

@@ -75,4 +73,3 @@ export default async function () {
7573
}
7674
```
7775

78-
{{< /code >}}

docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/putRecords.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'putRecords'
3-
head_title: 'KinesisClient.putRecords(streamName, records)'
43
description: 'KinesisClient.putRecords puts multiple records into a Kinesis stream'
54
weight: 10
65
---
@@ -50,7 +49,6 @@ Each record in the `records` array should be an object with the following proper
5049

5150
### Example
5251

53-
{{< code >}}
5452

5553
<!-- md-k6:skip -->
5654

@@ -119,4 +117,3 @@ export default async function () {
119117
}
120118
```
121119

122-
{{< /code >}}

0 commit comments

Comments
 (0)