docs(lib-dynamodb): add details to description of removeUndefinedValues

aws · Dec 2, 2024 · 548037e · 548037e
1 parent b5217c1
commit 548037e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/lib/lib-dynamodb/README.md b/lib/lib-dynamodb/README.md
@@ -105,7 +105,11 @@ export interface marshallOptions {
    */
   convertEmptyValues?: boolean;
   /**
-   * Whether to remove undefined values while marshalling.
+   * Whether to remove undefined values from JS arrays/Sets/objects
+   * when marshalling to DynamoDB lists/sets/maps respectively.
+   *
+   * A DynamoDB item is not itself considered a map. Only
+   * attributes of an item are examined.
    */
   removeUndefinedValues?: boolean;
   /**

diff --git a/packages/util-dynamodb/src/marshall.ts b/packages/util-dynamodb/src/marshall.ts
@@ -13,7 +13,11 @@ export interface marshallOptions {
    */
   convertEmptyValues?: boolean;
   /**
-   * Whether to remove undefined values while marshalling.
+   * Whether to remove undefined values from JS arrays/Sets/objects
+   * when marshalling to DynamoDB lists/sets/maps respectively.
+   *
+   * A DynamoDB item is not itself considered a map. Only
+   * attributes of an item are examined.
    */
   removeUndefinedValues?: boolean;
   /**