Skip to content

Commit c2d6893

Browse files
committed
improve tsdoc
1 parent 4644fb5 commit c2d6893

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

lib/lib-dynamodb/src/pagination/BatchGetPaginator.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ import { BatchGetCommand, BatchGetCommandInput, BatchGetCommandOutput } from "..
44
import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient";
55

66
/**
7-
* @public
8-
*
97
* Async generator that issues {@link BatchGetCommand}s repeatedly until all keys are processed or an error response is received.
108
*
9+
* @public
10+
*
1111
* @see {@link paginateBatchGetItem} for a variant that uses the {@link DynamoDBClient | low level DynamoDB client}.
1212
*
1313
* @example
1414
*
15-
* ```
15+
* ```typescript
1616
* const client = new DynamoDBClient();
1717
* const docClient = DynamoDBDocumentClient.from(client);
1818
* const input: BatchGetCommandInput = {

packages/util-dynamodb/src/paginateBatchGetItem.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ import { BatchGetItemCommand, BatchGetItemCommandInput, DynamoDBClient } from "@
22
import { type DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
33

44
/**
5-
* @public
6-
*
75
* Async generator that issues {@link BatchGetItemCommand}s repeatedly until all keys are processed or an error response is received.
86
*
7+
* @public
8+
*
99
* @see {@link paginateBatchGetItem} for a variant that uses the {@link DynamoDBDocumentClient | DynamoDB document client}.
1010
*
1111
* @example
1212
*
13-
* ```
13+
* ```typescript
1414
* const client = new DynamoDBClient();
1515
* const input: BatchGetCommandInput = {
1616
* RequestItems: {

0 commit comments

Comments
 (0)