Skip to content

Commit 044441e

Browse files
authored
docs(lib-dynamodb): add details to description of removeUndefinedValues (#6710)
1 parent 8acd39e commit 044441e

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

lib/lib-dynamodb/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,11 @@ export interface marshallOptions {
105105
*/
106106
convertEmptyValues?: boolean;
107107
/**
108-
* Whether to remove undefined values while marshalling.
108+
* Whether to remove undefined values from JS arrays/Sets/objects
109+
* when marshalling to DynamoDB lists/sets/maps respectively.
110+
*
111+
* A DynamoDB item is not itself considered a map. Only
112+
* attributes of an item are examined.
109113
*/
110114
removeUndefinedValues?: boolean;
111115
/**

packages/util-dynamodb/src/marshall.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ export interface marshallOptions {
1313
*/
1414
convertEmptyValues?: boolean;
1515
/**
16-
* Whether to remove undefined values while marshalling.
16+
* Whether to remove undefined values from JS arrays/Sets/objects
17+
* when marshalling to DynamoDB lists/sets/maps respectively.
18+
*
19+
* A DynamoDB item is not itself considered a map. Only
20+
* attributes of an item are examined.
1721
*/
1822
removeUndefinedValues?: boolean;
1923
/**

0 commit comments

Comments
 (0)