Skip to content

Commit 121de49

Browse files
authored
docs(document_client): update doc on input service instance (#4119)
1 parent d089bd1 commit 121de49

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

lib/dynamodb/document_client.d.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,11 @@ export namespace DocumentClient {
8888
*/
8989
params?: {[key: string]: any}
9090
/**
91-
* An optional pre-configured instance of the AWS.DynamoDB service object to use for requests. The object may bound parameters used by the document client.
91+
* An optional pre-configured instance
92+
* of the AWS.DynamoDB service object. This instance's config will be
93+
* copied to a new instance used by this client. You should not need to
94+
* retain a reference to the input object, and may destroy it or allow it
95+
* to be garbage collected.
9296
*/
9397
service?: DynamoDB
9498
}

lib/dynamodb/document_client.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ AWS.DynamoDB.DocumentClient = AWS.util.inherit({
4646
* @option options params [map] An optional map of parameters to bind to every
4747
* request sent by this service object.
4848
* @option options service [AWS.DynamoDB] An optional pre-configured instance
49-
* of the AWS.DynamoDB service object to use for requests. The object may
50-
* bound parameters used by the document client.
49+
* of the AWS.DynamoDB service object. This instance's config will be
50+
* copied to a new instance used by this client. You should not need to
51+
* retain a reference to the input object, and may destroy it or allow it
52+
* to be garbage collected.
5153
* @option options convertEmptyValues [Boolean] set to true if you would like
5254
* the document client to convert empty values (0-length strings, binary
5355
* buffers, and sets) to be converted to NULL types when persisting to

0 commit comments

Comments
 (0)