Skip to content

Commit 0dd8df7

Browse files
committed
Add params config option to service constructor docs.
Fixes #440
1 parent 95d5498 commit 0dd8df7

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc-src/templates/api-versions/plugin.rb

+3
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,9 @@ def add_class_documentation(service, klass, model, api_version)
123123
@example Constructing a #{klass} object
124124
var #{klass.downcase} = new AWS.#{klass}({apiVersion: '#{api_version}'});
125125
126+
@option options [map] params An optional map of parameters to bind to every
127+
request sent by this service object. For more information on bound parameters,
128+
see ["Working with Services" in the Getting Started Guide](/AWSJavaScriptSDK/guide/node-services.html#Bound_Parameters).
126129
@option options [String] endpoint The endpoint URI to send requests
127130
to. The default endpoint is built from the configured `region`.
128131
The endpoint should be a string like `'https://{service}.{region}.amazonaws.com'`.

0 commit comments

Comments
 (0)