Skip to content

Commit dff8ada

Browse files
authored
Add returnType documentation on paginated operation (#548)
* Add returnType documentation on paginated operation * Remove useless docblock in sample * Fix CS * Rebase * Remove useless 'uses' * Fix psalm issue
1 parent 9ff4300 commit dff8ada

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Change Log
22

3+
## 0.2.1
4+
5+
### Fixed
6+
7+
- Add return typehint for `listTables`, `query` and `scan`
8+
39
## 0.2.0
410

511
### Added

src/DynamoDbClient.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
use AsyncAws\DynamoDb\Result\TableNotExistsWaiter;
2929
use AsyncAws\DynamoDb\Result\UpdateItemOutput;
3030
use AsyncAws\DynamoDb\Result\UpdateTableOutput;
31+
use AsyncAws\DynamoDb\ValueObject\AttributeValue;
3132

3233
class DynamoDbClient extends AbstractApi
3334
{
@@ -164,6 +165,8 @@ public function getItem($input): GetItemOutput
164165
* Limit?: int,
165166
* @region?: string,
166167
* }|ListTablesInput $input
168+
*
169+
* @return \Traversable<string> & ListTablesOutput
167170
*/
168171
public function listTables($input = []): ListTablesOutput
169172
{
@@ -230,6 +233,8 @@ public function putItem($input): PutItemOutput
230233
* ExpressionAttributeValues?: array<string, \AsyncAws\DynamoDb\ValueObject\AttributeValue>,
231234
* @region?: string,
232235
* }|QueryInput $input
236+
*
237+
* @return \Traversable<array<string, AttributeValue>> & QueryOutput
233238
*/
234239
public function query($input): QueryOutput
235240
{
@@ -264,6 +269,8 @@ public function query($input): QueryOutput
264269
* ConsistentRead?: bool,
265270
* @region?: string,
266271
* }|ScanInput $input
272+
*
273+
* @return \Traversable<array<string, AttributeValue>> & ScanOutput
267274
*/
268275
public function scan($input): ScanOutput
269276
{

0 commit comments

Comments
 (0)