From 548037e513a7f20f66662609d4910434f7000adc Mon Sep 17 00:00:00 2001 From: George Fu Date: Mon, 2 Dec 2024 19:53:55 +0000 Subject: [PATCH] docs(lib-dynamodb): add details to description of removeUndefinedValues --- lib/lib-dynamodb/README.md | 6 +++++- packages/util-dynamodb/src/marshall.ts | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/lib-dynamodb/README.md b/lib/lib-dynamodb/README.md index 9fed58f274b8..fc88a486c7e1 100644 --- 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 index 10cc7c4970e2..6e3320905148 100644 --- 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; /**